Added Install instructions to the README. 100/head
authorLucian Ursu <lucian.ursu@gmail.com>
Fri, 8 Mar 2013 13:04:39 +0000 (15:04 +0200)
committerLucian Ursu <lucian.ursu@gmail.com>
Fri, 8 Mar 2013 13:04:39 +0000 (15:04 +0200)
README.rst

index 5727db0e773d6e0d9ab69af76ee97ec5c19d08c3..ea32246b546892fbc5b7074d9be53afe7e38567e 100644 (file)
@@ -25,7 +25,34 @@ TODO: Put docs on [RTFD](https://readthedocs.org/)
 
 Install
 =======
+If you're starting to work on this project and you need it setup on your local
+machine, follow the steps below.
 
+1. Make sure you have installed ``git``, the ``PostgreSQL`` server, client and
+   development files, ``Python`` including the development files, ``Fabric``,
+   ``pip``, ``virtualenv`` and ``virtualenvwrapper``.
+
+2. Clone the project from the central repo::
+
+        git clone git@github.com:FinalsClub/karmaworld.git
+
+Note that you have to have your SSH keys setup on GitHub to use this URL. If
+you don't, you can use the HTTP URL:
+``https://github.com/FinalsClub/karmaworld.git``.
+
+3. Create a database and optionally a username and put them in the
+   ``DATABASES`` setting in a ``local.py`` file that you'll place in
+   ``karmaworld/settings/``.
+
+4. Make sure that you're in the root of the project that you just cloned and
+   run::
+
+        fab here first_deploy
+
+This will make a virtualenv, install the development dependencies and create
+the database tables.
+
+5. Now you can run ``./manage.py runserver`` and visit the site in the browser.
 
 Thanks
 ======