Miguel Barão / perguntations

Download as
Browse Code »

Commit c3e00c9247d2cf9d81f4e10677036a8205693099

Authored by Miguel Barao
1 parent 94ba5a95
Exists in master and in 1 other branch dev

- update README.md

Showing 2 changed files with 8 additions and 11 deletions   Show diff stats
README.md
  Diff comments   View file @c3e00c9
... ... @@ -3,9 +3,9 @@
3 3  
4 4 ### Requirements:
5 5  
6   -The webserver is a python3 application and only requires python to be installed. Requires python 3.5 or above. It does not require any other webserver (apache, ...)
  6 +The webserver is a python 3.5+ application.
7 7  
8   -Installed using `pip`:
  8 +Requires the following python packages, which can be installed using `pip`:
9 9  
10 10 - CherryPy (>=3.7.0)
11 11 - Mako (>=1.0.1)
... ... @@ -23,11 +23,11 @@ Run the following commands:
23 23 cd WHERE/TO/PUT/THE/SOFTWARE
24 24  
25 25 # get software using git
26   -git clone https://mjsb@bitbucket.org/mjsb/perguntations.git
  26 +git clone https://USER@bitbucket.org/USER/perguntations.git
27 27 cd perguntations
28 28  
29 29 # create database (if no csv file is provided, a database with 5 fake students is created for debugging)
30   -./initdb_from_csv.py YOUR_CSV_FILE_HERE
  30 +./initdb.py CSV_FILE_HERE
31 31 mv students.db SOMEWHERE
32 32  
33 33 # update test configuration with the correct database file.
... ... @@ -35,9 +35,8 @@ vi demo/test.yaml
35 35 # Edit line 7 to something like
36 36 # database: SOMEWHERE/students.db
37 37  
38   -# edit server configuration
  38 +# edit server configuration if needed
39 39 vi config/server.conf
40   -# Edit lines 26--27 to point to the desired log files location.
41 40  
42 41 # get help
43 42 ./serve.py --help
... ... @@ -46,14 +45,15 @@ vi config/server.conf
46 45 ./serve.py demo/test.yaml
47 46  
48 47 # open browser at http://127.0.0.1:8080/
49   -# the professor is number 0
  48 +# the professor/administrator is number 0
50 49  
51 50 # ^C to terminate the server
52 51 ```
53 52  
54 53 ### Troubleshooting
55 54  
56   -* If you are getting any `UnicodeEncodeError` type of errors that's because the terminal is not supporting UTF-8. Try running `locale` on the terminal and see if there is any error messages. Fix it with `sudo dpkg-reconfigure locales`, select your UTF-8 locales and try again.
  55 +* If you are getting any `UnicodeEncodeError` type of errors that's because the terminal is not supporting UTF-8. Try running `locale` on the terminal and see if there is any error messages. Solutions:
  56 + - debian: fix it with `sudo dpkg-reconfigure locales`, select your UTF-8 locales and try again.
57 57  
58 58 ### Contribute ###
59 59  
... ...
demo/test.yaml
  Diff comments   View file @c3e00c9
... ... @@ -18,9 +18,6 @@ show_points: True
18 18 # Show question's hint if available (default: False)
19 19 show_hints: True
20 20  
21   -# In practice mode a test can be repeat any number of times (default: False)
22   -# practice: False
23   -
24 21 # Show lots of information for debugging (default: False)
25 22 # debug: True
26 23  
... ...