diff options
| l---------[-rw-r--r--] | README | 81 | ||||
| -rw-r--r-- | README.md | 80 |
2 files changed, 81 insertions, 80 deletions
@@ -1,80 +1 @@ -# Archweb README - -To get a pretty version of this document, run - - $ markdown README > README.html - -# License - -See LICENSE file. - -# Authors - -See AUTHORS file. - -# Dependencies - -- python2 -- python2-virtualenv - -# Python dependencies - -More detail in `requirements.txt` and `requirements_prod.txt`; it is best to -use virtualenv and pip to handle these. But if you insist on (Arch Linux) -packages, you will probably want the following: - -- django -- python2-psycopg2 -- python2-markdown -- python2-south -- python2-memcached - -# Testing Installation - -1. Run `virtualenv2`. - - $ cd /path/to/archweb && virtualenv2 ./env/ - -2. Activate the virtualenv. - - $ source ./env/bin/activate - -2. Install dependencies through `pip`. - - (archweb-env) $ pip install -r requirements.txt - -3. Copy `local_settings.py.example` to `local_settings.py` and modify. - Make sure to uncomment the appropriate database section (either sqlite or - PostgreSQL). - -4. Sync the database to create it. - - (archweb-env) $ ./manage.py syncdb - -5. Migrate changes. - - (archweb-env) $ ./manage.py migrate - -6. Load the fixtures to prepopulate some data. If you don't want some of the - provided data, adjust the file glob accordingly. - - (archweb-env) $ ./manage.py loaddata */fixtures/*.json - -7. Use the following commands to start a service instance - - (archweb-env) $ ./manage.py runserver - -8. To optionally populate the database with real data: - - (archweb-env) $ wget ftp://ftp.archlinux.org/core/os/i686/core.db.tar.gz - (archweb-env) $ ./manage.py reporead i686 core.db.tar.gz - (archweb-env) $ ./manage.py syncisos - -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: +README.md
\ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..beeb7f99 --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +# Archweb README + +To get a pretty version of this document, run + + $ markdown README > README.html + +# License + +See LICENSE file. + +# Authors + +See AUTHORS file. + +# Dependencies + +- python2 +- python2-virtualenv + +# Python dependencies + +More detail in `requirements.txt` and `requirements_prod.txt`; it is best to +use virtualenv and pip to handle these. But if you insist on (Arch Linux) +packages, you will probably want the following: + +- django +- python2-psycopg2 +- python2-markdown +- python2-south +- python2-memcached + +# Testing Installation + +1. Run `virtualenv2`. + + $ cd /path/to/archweb && virtualenv2 ./env/ + +2. Activate the virtualenv. + + $ source ./env/bin/activate + +2. Install dependencies through `pip`. + + (archweb-env) $ pip install -r requirements.txt + +3. Copy `local_settings.py.example` to `local_settings.py` and modify. + Make sure to uncomment the appropriate database section (either sqlite or + PostgreSQL). + +4. Sync the database to create it. + + (archweb-env) $ ./manage.py syncdb + +5. Migrate changes. + + (archweb-env) $ ./manage.py migrate + +6. Load the fixtures to prepopulate some data. If you don't want some of the + provided data, adjust the file glob accordingly. + + (archweb-env) $ ./manage.py loaddata */fixtures/*.json + +7. Use the following commands to start a service instance + + (archweb-env) $ ./manage.py runserver + +8. To optionally populate the database with real data: + + (archweb-env) $ wget ftp://ftp.archlinux.org/core/os/i686/core.db.tar.gz + (archweb-env) $ ./manage.py reporead i686 core.db.tar.gz + (archweb-env) $ ./manage.py syncisos + +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: |