Improve docs.

[xnet] / doc / setup.rst

New developer setup
===================

This document should guide a new developer through his initial setup of platal2.


Getting the code
----------------

You should fetch the git repository:

- Readonly, from git://git.polytechnique.org/xnet.git
- Read/write, from git.polytechnique.org:/home/git/xnet.git

.. code-block:: sh

    cd ~/dev
    git clone x1829vaneau@murphy.polytechnique.org:/home/git/xnet.git


Installing dependencies
-----------------------

First, install required (system) packages:

* Python2.7 (with sqlite support)
* virtualenv (or virtualenvwrapper)

Then, you can create your virtualenv.
It will host a dedicated Python installation, with all required dependencies,
without affecting the rest of your setup.

.. code-block:: sh

    virtualenv ~/dev/xnet_venv
    . ~/dev/xnet_venv/bin/activate

Now, install the dependencies:

.. code-block:: sh

    cd ~/dev/xnet
    pip install -r requirements.txt -r dev_requirements.txt


Setting up the database
-----------------------

The development database is backed by sqlite, and should work out of the box:

.. code-block:: sh

    cd ~/dev/xnet
    . ~/dev/xnet_venv/bin/activate

    make resetdb


.. note:: The provided Makefile holds a few helpful commands.
          Use ``make help`` to get a list of available commands.


You may now populate your database with some development data:

.. code-block:: sh

    ./manage.py loadatasets dev


Testing the system
------------------

The simplest way to test the system is to start the built-in HTTP server:

.. code-block:: sh

    make run

Now, open your browser on http://localhost:8000/, you should see the base page.