Miguel Barão / perguntations

Download as
Browse Code »

Commit 902c35b2e34ae1b6b7ea3717d030176a39334da6

Authored by Miguel Barão
1 parent c147c920
Exists in master and in 1 other branch dev

changes in README.md

Showing 1 changed file with 13 additions and 9 deletions   Show diff stats
1 - # README # 1 +# README.md
2 2
3 1. [Requirements](#requirements) 3 1. [Requirements](#requirements)
4 1. [Installation](#installation) 4 1. [Installation](#installation)
@@ -104,18 +104,20 @@ initdb --add 123 "Asterix Gaules" # add one student @@ -104,18 +104,20 @@ initdb --add 123 "Asterix Gaules" # add one student
104 104
105 This will create or update a `students.db` file that contains a sqlite3 105 This will create or update a `students.db` file that contains a sqlite3
106 database. 106 database.
107 -The database stores user passwords and grades (but not the actual tests). 107 +The database stores user passwords and grades, but not the actual tests.
108 108
109 -The complete tests are stored in JSON files in the following directory: 109 +A test is specified in a single `yaml` file.
  110 +The demo already includes the `tutorial.yaml` that you can play with.
  111 +
  112 +The complete tests submitted by the students are stored in JSON files in the
  113 +directory defined in `tutorial.yaml` under the option `answers_dir: ans`.
  114 +We also have to create this directory manually:
110 115
111 ```bash 116 ```bash
112 mkdir ans # directory where the tests will be saved 117 mkdir ans # directory where the tests will be saved
113 ``` 118 ```
114 119
115 -A test is specified in a single `yaml` file.  
116 -The demo already includes the `tutorial.yaml` that you can play with.  
117 -  
118 -Start the server and run this test: 120 +Start the server and run the `tutorial.yaml` test:
119 121
120 ```bash 122 ```bash
121 perguntations tutorial.yaml # run demo test 123 perguntations tutorial.yaml # run demo test
@@ -125,8 +127,10 @@ Several options are available, run `perguntations --help` for a list. @@ -125,8 +127,10 @@ Several options are available, run `perguntations --help` for a list.
125 127
126 The server listens on port 8443 of all IPs of all network interfaces. 128 The server listens on port 8443 of all IPs of all network interfaces.
127 Open the browser at `http://127.0.0.1:8443/` and login as user number `0` 129 Open the browser at `http://127.0.0.1:8443/` and login as user number `0`
128 -(administrator) and choose any password. The administrator is redirected to the  
129 -administration page that shows all the students and their state. 130 +(administrator) and choose any password you want. The password is defined on
  131 +first login.
  132 +After logging in, you will be redirected to the administration page that shows
  133 +all the students and their current state.
130 134
131 1. Authorize students by clicking the checkboxes. 135 1. Authorize students by clicking the checkboxes.
132 2. Open a different browser (or exit administrator) at `http://127.0.0.1:8443/` 136 2. Open a different browser (or exit administrator) at `http://127.0.0.1:8443/`