Parcourir la source

Update of documentation

Jérôme BUISINE il y a 4 ans
Parent
commit
46d4325837
1 fichiers modifiés avec 36 ajouts et 8 suppressions
  1. 36 8
      README.md

+ 36 - 8
README.md

@@ -4,12 +4,6 @@
 
 Project for generating users links in order to launch SIN3D application quickly during experiment.
 
-## Requirements
-
-```
-pip install -r requirements.txt
-```
-
 ## How to use ?
 
 
@@ -23,16 +17,24 @@ Generate experiment links for each user (file saved into `expe` folder):
 python links/generate/generate_experiment.py --data data/expe1.csv --scenes 2 --users 150 --userId 1 --output expe1_user_links.csv
 ```
 
+- `userId`: tell if an userId is used or not (use of index of line from generated output file)
+
 The final file is generated and contains data just as follow:
 
 ```
-link1;link2;...;linkN
+0;sceneName1:::link1;sceneName2:::link2;...;sceneNameN:::linkN
 ...
-link2;link3;...;linkN
+N;sceneName2:::link2;sceneName3:::link3;...;sceneNameN:::linkN
 ```
 
 ## Launch WebApp
 
+### 1. Manually
+
+```
+pip install -r requirements.txt
+```
+
 ```
 python manage.py migrate
 ```
@@ -41,6 +43,32 @@ python manage.py migrate
 python manage.py runserver
 ```
 
+### 2. Using docker (recommended)
+
+You can use make commands:
+
+```
+make build
+```
+
+```
+make run
+```
+
+Or simply:
+
+```
+make deploy
+```
+
+Will run `build` and `run` commands at once.
+
+You also have `stop`, `remove`, `clean` commands:
+- `stop`: stop current container instance if exists
+- `remove`: stop and remove container instance if exists
+- `clean`: remove docker image if exists
+
+
 ## Licence
 
 [The MIT license](LICENSE)