Browse Source

Fix typo and markdown syntax in README

Baptiste Jonglez 9 years ago
parent
commit
0af6c8da49
1 changed files with 19 additions and 22 deletions
  1. 19 22
      README.md

+ 19 - 22
README.md

@@ -23,12 +23,10 @@ A mailing list is available, for both users and developers: https://listes.illys
 Demo
 ====
 
-A demo of COIN is publicly available at:
+A demo of COIN is publicly available at https://coin-dev.illyse.org
 
-  https://coin-dev.illyse.org
-
-Login: ffdn
-Password: internet
+- Login: ffdn
+- Password: internet
 
 This user account has access to the administration interface.
 
@@ -51,26 +49,26 @@ replace the `virtualenv` command with `virtualenv2` in the following.
 
 To create the virtualenv (the first time):
 
-  virtualenv ~/tmp/venv-illyse
+    virtualenv ~/tmp/venv-illyse
 
 
 To activate the virtualenv (you need to do this each time you work on
 the project):
 
-  . ~/tmp/venv-illyse/bin/activate
+    . ~/tmp/venv-illyse/bin/activate
 
 
 Install dependencies. On Debian, you will probably need the
 `python-dev`, `python-pip`, `libldap-dev`, `libpq-dev` and `libsasl2-dev`
 packages.
 
-  sudo apt-get install python-dev python-pip libldap2-dev libpq-dev libsasl2-dev
+    sudo apt-get install python-dev python-pip libldap2-dev libpq-dev libsasl2-dev
 
 Then run:
 
-  pip install -r requirements.txt
+    pip install -r requirements.txt
 
-You may experience problems with SSL certificates du to self-signed cert used by code.ffdn.org. You can temporarily disable certificate verification in git : git config --global http.sslVerify false
+You may experience problems with SSL certificates du to self-signed cert used by code.ffdn.org. You can temporarily disable certificate verification in git : `git config --global http.sslVerify false`
 
 You should now be able to run `python manage.py` (within the
 virtualenv, obviously) without error.
@@ -102,9 +100,7 @@ SQLite might work, but some features will not be available:
 - sending automated emails to remind of expiring membership fee
   (needs aggregation on date fields, see Django doc)
 
-For more information on the database setup, see:
-
-  https://www.illyse.org/projects/ils-si/wiki/Mise_en_place_environnement_de_dev
+For more information on the database setup, see https://www.illyse.org/projects/ils-si/wiki/Mise_en_place_environnement_de_dev
 
 The first time, you need to create the database, create a superuser, and
 import some base data to play with:
@@ -175,7 +171,8 @@ in the admin.  Information entered in this application has two purposes:
 
 
 Some bits of configuration are done in `settings.py`: LDAP branches, RSS feeds
-to display on the home page, and so on.
+to display on the home page, and so on.  Lastly, it is possible to override
+all Coin templates (i.e. for user views and emails), see below.
 
 Cron tasks
 ----------
@@ -207,16 +204,18 @@ your structure needs.
 Coin allows you to have a folder of custom templates that will contain your
 templates, which gets loaded prior to coin builtins.
 
-The templates you may override are stored in several places :
+With this method, several templates can be overridden:
 
-- `coin/templates/`
-- `coin/<app_name>/templates/` folders (iterating every app)
+- template files in `coin/templates/`
+- template files in `coin/<app_name>/templates/` for all active applications
 
 ### Do once (setup)
 
 - Create a folder dedicated to your custom templates (*hint: outside of coin git
   tree is better*).
-- Register that folder in the `EXTRA_TEMPLATE_DIRS` settings. Ex:
+- Register that folder in the `EXTRA_TEMPLATE_DIRS` settings.
+
+For instance, in `settings_local.py`:
 
     EXTRA_TEMPLATE_DIRS = ('/home/coin/my-folder/templates',)
 
@@ -227,7 +226,7 @@ Copy the template you want to override to the right place in your custom
 
 *Example*
 
-Say we want to override the temalet located at
+Say we want to override the template located at
 `coin/members/templates/members/emails/call_for_membership_fees.html` and we
 set `EXTRA_TEMPLATE_DIRS = ('/home/coin/my-folder/templates',)` in settings.
 
@@ -239,8 +238,6 @@ Good to go :-)
 More information
 ================
 
-For the rest of the setup (database, LDAP), see
-
-  https://www.illyse.org/projects/ils-si/wiki/Mise_en_place_environnement_de_dev
+For the rest of the setup (database, LDAP), see https://www.illyse.org/projects/ils-si/wiki/Mise_en_place_environnement_de_dev
 
 For real production deployment, see file `DEPLOYMENT.md`.