From 1896ddb2e0548ae7c3882d4358f2631499d46328 Mon Sep 17 00:00:00 2001
From: Miguel Barao <miguel.barao@gmail.com>
Date: Fri, 11 Mar 2016 12:31:21 +0000
Subject: [PATCH] - added the logs directory to git - modified config/server.conf to point to logs/ directory - modified demo/test.yaml with better explanations

---
 config/server.conf |  4 ++--
 demo/test.yaml     | 54 +++++++++++++++++++++++++++---------------------------
 logs/.gitignore    |  2 ++
 3 files changed, 31 insertions(+), 29 deletions(-)
 create mode 100644 logs/.gitignore

diff --git a/config/server.conf b/config/server.conf
index 075cbe4..d5d121d 100644
--- a/config/server.conf
+++ b/config/server.conf
@@ -23,8 +23,8 @@ server.socket_port = 8080
 log.screen = False
 
 # add path to the log files here. empty strings disable logging
-log.error_file = '/Users/mjsb/Work/Projects/perguntations/logs/errors.log'
-log.access_file = ''
+log.error_file = 'logs/errors.log'
+log.access_file = 'logs/access.log'
 
 # DO NOT DISABLE SESSIONS!
 tools.sessions.on = True
diff --git a/demo/test.yaml b/demo/test.yaml
index 10294e2..cff22b5 100644
--- a/demo/test.yaml
+++ b/demo/test.yaml
@@ -2,61 +2,61 @@
 ref: demo
 title: Teste de Demonstração
 
-# database contains students+passwords, final results of the tests, and questions done
-# database: path/to/students.db
-database: db/students.db
+# Database with student credentials and grades of all questions and tests done
+# The database is an sqlite3 file generate with the script initdb_from_csv.py
+database: demo/students.db
 
-# this will generate a file for each test done. The file is like a replacement
-# for a test done in paper.
-answers_dir: ans/demo
+# (optional) Generate a file for each test done by a student.
+# It includes the questions, answers and grades.
+# If undefined, then no tests are saved (useful for debug and training)
+# answers_dir: WHERE_TO_SAVE_THE_TESTS
 
+# Show points for each question, scale 0-20 (default: False)
 show_points: True
+
+# Show question's hint if available (default: False)
 show_hints: True
+
+# In practice mode a test can be repeat any number of times (default: False)
 practice: True
-# debug: False
+
+# Show lots of information for debugging (default: False)
+# debug: True
 
 #-----------------------------------------------------------------------------
 # Base path applied to the questions files and all the scripts
 # including question generators and correctors.
 # Either absolute path or relative to current directory.
 questions_dir: demo
-# (Note: answers are saved in a different path defined in answers_dir)
 
-#-----------------------------------------------------------------------------
-# List of files containing questions in yaml format.
+# (optional) List of files containing questions in yaml format.
 # Selected questions will be obtained from these files.
-# If no files are provided, all files in questions_dir are loaded.
+# If undefined, all files in questions_dir are loaded.
 files:
     - questions.yaml
 
-#-----------------------------------------------------------------------------
 # This is the list of questions. If a "ref:" has a list of keys, then
 # one question is selected from the list.
 # The following example will generate a test with 3 questions.
 questions:
-    # first
+    # first question
     - ref:
-        # choose 1 from the following 3 questions
+        # choose 1 from the following 2 questions
         - solar-system-mars
         - solar-system-jupiter
       points: 0.5
 
-    # second
+    # second question
     - ref:
         - question-v1
         - question-v2
-        # points: 1.0 is the default, if not defined here.
-
-    # 3.
-    - ref:
-        - question-colors
-
-    # 4.
-    - ref:
-        - question-whatever
+        # points: 1.0 is the default, if omitted
 
-    # 5.
-    - ref: one-question
+    # one question
+    - ref: question-colors
+      points: 1.5
 
-    # 6.
+    # just use defaults
+    - question-whatever
+    - one-question
     - another-question
diff --git a/logs/.gitignore b/logs/.gitignore
new file mode 100644
index 0000000..d6b7ef3
--- /dev/null
+++ b/logs/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
--
libgit2 0.21.2