From: Lucian Ursu <lucian.ursu@gmail.com>
Date: Fri, 8 Mar 2013 13:04:39 +0000 (+0200)
Subject: Added Install instructions to the README.
X-Git-Tag: release-20150131~498^2~2^2
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=19543a6a43e081b796762019e44120a23dd3deb8;p=oweals%2Fkarmaworld.git

Added Install instructions to the README.
---

diff --git a/README.rst b/README.rst
index 5727db0..ea32246 100644
--- a/README.rst
+++ b/README.rst
@@ -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
 ======