Commit 6eb2ad2e authored by Ángel Velásquez's avatar Ángel Velásquez Committed by Dan McGee
Browse files

Update README



This was in dire need of a rewrite, so it gets one here.
Signed-off-by: default avatarDan McGee <dan@archlinux.org>
parent 3682fb28
# Archweb README
To get a pretty version of this document, run
$ markdown README > README.html
# License # License
See LICENSE file.
See LICENSE file.
# Authors # Authors
See AUTHORS file.
See AUTHORS file.
# Dependencies # Dependencies
- python
- mysql-python or python-pysqlite
- Django >= 1.2.X
# Installation - python
For a simple testing installation: - python-virtualenv
# Python dependencies
More detail in `requirements.txt` and `requirements_prod.txt`; it is best to
use virtualenv to handle these. But if you insist on (Arch Linux) packages, you
will probably want the following:
- mysql-python or python-pysqlite
- django
- python-markdown
- python-south
- python-memcached
# Testing Installation
1. Run `virtualenv`.
1. Install dependencies. $ cd /path/to/archweb && virtualenv ../archweb
$ pacman -S django python-pysqlite sqlite3
2. Copy local_settings.py.example to local_settings.py and modify. 2. Install dependencies through `pip`.
$ pip -r requirements.txt
3. Copy `local_settings.py.example` to `local_settings.py` and modify.
Make sure to uncomment the appropriate db section (either sqlite or mysql). Make sure to uncomment the appropriate db section (either sqlite or mysql).
3. Sync the database to create it. 4. Sync the database to create it.
$ python manage.py syncdb $ python manage.py syncdb
4. Load the fixtures to prepopulate some data. 5. Migrate changes.
$ python manage.py loaddata arches.json repos.json
$ python manage.py migrate
6. Load the fixtures to prepopulate some data.
$ python manage.py loaddata main/fixtures/arches.json main/fixtures/repos.json
7. Use the following commands to start a service instance
5. Use the following commands to start a service instance
$ python manage.py runserver $ python manage.py runserver
6. To optionally populate the database with real data: 8. To optionally populate the database with real data:
$ wget ftp://ftp.archlinux.org/core/os/i686/core.db.tar.gz $ wget ftp://ftp.archlinux.org/core/os/i686/core.db.tar.gz
$ ./manage.py reporead i686 core.db.tar.gz $ ./manage.py reporead i686 core.db.tar.gz
(alter architecture and repo to get x86_64 and extra packages if needed) Alter architecture and repo to get x86\_64 and packages from other repos if needed.
# Production Installation
Ask someone who knows, or you are going to be in trouble.
vim: set syntax=markdown et:
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment