follow GNU naming conventions

1 files changed, 60 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..118ed56
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,60 @@
+================== HOW RUN THE PYTHON BANK =====================
+
+---------------------1 The Pythonic way ------------------------
+
+Make sure your system has 'virtualenv' and 'pip' installed.
+For example, on Debian systems, run:
+
+# apt-get install virtualenv python-pip
+
+Currently, the bank runs on Python 2.7.
+
+Next, create an environment which will "host" the bank's dependencies:
+
+$ virtualenv bank_env
+
+This should create a directory named 'bank_env/' in your current
+working directory.
+That directory will contain all the Pythonic dependencies of the bank.
+
+To activate your environment in the current shell, use:
+
+$ source bank_env/bin/activate
+
+(To later deactivate it, you can simply close the shell.)
+Inside the "activated" shell, install the dependencies:
+
+$ pip install -r requirements.txt
+
+The file 'requirements.txt' is contained in this folder.
+
+Once the environment is set up, the bank can be launched. For that
+purpose, you need to first
+
+$ cd TalerBank/
+
+Before actually launching the bank, the bank's database must be
+initialized. Give the following two commands (respecting the
+sequence):
+
+$ python manage.py makemigrations
+$ python manage.py migrate
+
+The following command is also needed, in order to create some predefined
+accounts:
+
+$ python manage.py pre_account
+
+If everything has worked fine, launch the bank's web server with:
+
+$ python manage.py runserver 127.0.0.1:8080
+
+The bank's homepage is now available at http://127.0.0.1:8080/auth/
+
+--------------------- 2 The GNU way ----------------------------
+
+TBD.
+
+----------------- 3 How to bind Django and nginx ---------------
+
+[1] http://uwsgi-docs.readthedocs.org/en/latest/tutorials/Django_and_nginx.html