add documentations about settings and devtools

README.md

@@ -47,7 +47,7 @@ Install the project in editable mode with its testing requirements:
 
 ### Configure Tracim_backend ###
 
-Create configuration files for a development environment:
+Create [configuration file](doc/setting.md) for a development environment:
 
     cp development.ini.base development.ini
 

doc/devtools.md

@@ -0,0 +1,28 @@
+# Devtools
+
+# Check third party licences
+
+Install `yolk3k` pip package:
+
+    pip install yolk3k
+
+Then execute command:
+
+    yolk -l -f license
+
+Output will look like:
+
+```
+PyYAML (3.12) !
+    License: MIT
+
+Pygments (2.2.0) !
+    License: BSD License
+
+SQLAlchemy (1.2.5) !
+    License: MIT License
+
+Unidecode (1.0.22) !
+    License: GPL
+...
+```

doc/setting.md

@@ -0,0 +1,46 @@
+# Setting #
+
+Here is a short description of settings available in the file `development.ini`.
+
+## Listening port ##
+
+Default configuration is to listen on port 6534.
+If you want to adapt this to your environment, edit the `.ini` file and setup the port you want:
+
+    [server:main]
+    ...
+    listen = localhost:6543
+
+To allow other computer to access to this website, listen to "*" instead of localhost:
+
+    [server:main]
+    ...
+    listen = *:6534
+
+## Prod/Debug configuration ##
+
+
+To enable simple debug conf:
+
+    [app:main]
+    ...
+    pyramid.reload_templates = true
+    pyramid.debug_all = true
+    pyramid.includes =
+        pyramid_debugtoolbar
+
+production conf (no reload, no debugtoolbar):
+
+    [app:main]
+    ...
+    pyramid.reload_templates = false
+    pyramid.debug_authorization = false
+    pyramid.debug_notfound = false
+    pyramid.debug_routematch = false
+
+You can, of course, also set level of one of the different logger to have more/less log
+about something.
+
+    [logger_sqlalchemy]
+    ...
+    level = INFO