Parcourir la source

Format README

Mathieu il y a 6 ans
Parent
commit
4bcbbda819
1 fichiers modifiés avec 20 ajouts et 7 suppressions
  1. 20 7
      README.md

+ 20 - 7
README.md

@@ -6,25 +6,35 @@ a virtual environment (like virtualenv).
 
 Install packages:
 
-    # apt-get install python3-pip python3-virtualenv virtualenv libyaml-dev
+```bash
+sudo apt-get install python3-pip python3-virtualenv virtualenv libyaml-dev
+```
 
 Retrieve the repository:
 
-    $ git clone https://code.ffdn.org/FFDN/wifi-with-me.git
-    $ cd wifi-with-me
+```bash
+git clone https://code.ffdn.org/FFDN/wifi-with-me.git
+cd wifi-with-me
+```
 
 Create and activate the virtualenv with:
 
-    $ virtualenv -p $(which python3) venv
-    $ source venv/bin/activate
+```bash
+virtualenv -p $(which python3) venv
+source venv/bin/activate
+```
 
 We use django framework.  Install it from requirements with pip:
 
-    $ pip install -r requirements/base.txt
+```bash
+pip install -r requirements/base.txt
+```
 
 For development, install `dev.txt` instead:
 
-    $ pip install -r requirements/dev.txt
+```bash
+pip install -r requirements/dev.txt
+```
 
 Set up configuration
 ====================
@@ -129,6 +139,9 @@ data follow this extra step :
 Run development server
 ======================
 
+NOTE: For prod environment, replace `./manage.py` by
+`DJANGO_SETTINGS_MODULE=wifiwithme.settings.prod ./manage.py`.
+
 It is required to initialize database first:
 
 ```bash