From 902c35b2e34ae1b6b7ea3717d030176a39334da6 Mon Sep 17 00:00:00 2001 From: Miguel Barão Date: Wed, 13 Feb 2019 17:18:09 +0000 Subject: [PATCH] changes in README.md --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f9b632e..80f26fa 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - # README # +# README.md 1. [Requirements](#requirements) 1. [Installation](#installation) @@ -104,18 +104,20 @@ initdb --add 123 "Asterix Gaules" # add one student This will create or update a `students.db` file that contains a sqlite3 database. -The database stores user passwords and grades (but not the actual tests). +The database stores user passwords and grades, but not the actual tests. -The complete tests are stored in JSON files in the following directory: +A test is specified in a single `yaml` file. +The demo already includes the `tutorial.yaml` that you can play with. + +The complete tests submitted by the students are stored in JSON files in the +directory defined in `tutorial.yaml` under the option `answers_dir: ans`. +We also have to create this directory manually: ```bash mkdir ans # directory where the tests will be saved ``` -A test is specified in a single `yaml` file. -The demo already includes the `tutorial.yaml` that you can play with. - -Start the server and run this test: +Start the server and run the `tutorial.yaml` test: ```bash perguntations tutorial.yaml # run demo test @@ -125,8 +127,10 @@ Several options are available, run `perguntations --help` for a list. The server listens on port 8443 of all IPs of all network interfaces. Open the browser at `http://127.0.0.1:8443/` and login as user number `0` -(administrator) and choose any password. The administrator is redirected to the -administration page that shows all the students and their state. +(administrator) and choose any password you want. The password is defined on +first login. +After logging in, you will be redirected to the administration page that shows +all the students and their current state. 1. Authorize students by clicking the checkboxes. 2. Open a different browser (or exit administrator) at `http://127.0.0.1:8443/` -- libgit2 0.21.2