From c3e00c9247d2cf9d81f4e10677036a8205693099 Mon Sep 17 00:00:00 2001 From: Miguel Barao Date: Tue, 5 Jul 2016 17:35:45 +0100 Subject: [PATCH] - update README.md --- README.md | 16 ++++++++-------- demo/test.yaml | 3 --- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 600d4df..df0e363 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ ### Requirements: -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, ...) +The webserver is a python 3.5+ application. -Installed using `pip`: +Requires the following python packages, which can be installed using `pip`: - CherryPy (>=3.7.0) - Mako (>=1.0.1) @@ -23,11 +23,11 @@ Run the following commands: cd WHERE/TO/PUT/THE/SOFTWARE # get software using git -git clone https://mjsb@bitbucket.org/mjsb/perguntations.git +git clone https://USER@bitbucket.org/USER/perguntations.git cd perguntations # create database (if no csv file is provided, a database with 5 fake students is created for debugging) -./initdb_from_csv.py YOUR_CSV_FILE_HERE +./initdb.py CSV_FILE_HERE mv students.db SOMEWHERE # update test configuration with the correct database file. @@ -35,9 +35,8 @@ vi demo/test.yaml # Edit line 7 to something like # database: SOMEWHERE/students.db -# edit server configuration +# edit server configuration if needed vi config/server.conf -# Edit lines 26--27 to point to the desired log files location. # get help ./serve.py --help @@ -46,14 +45,15 @@ vi config/server.conf ./serve.py demo/test.yaml # open browser at http://127.0.0.1:8080/ -# the professor is number 0 +# the professor/administrator is number 0 # ^C to terminate the server ``` ### Troubleshooting -* 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. +* 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: + - debian: fix it with `sudo dpkg-reconfigure locales`, select your UTF-8 locales and try again. ### Contribute ### diff --git a/demo/test.yaml b/demo/test.yaml index 87a92b0..31699ec 100644 --- a/demo/test.yaml +++ b/demo/test.yaml @@ -18,9 +18,6 @@ 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: False - # Show lots of information for debugging (default: False) # debug: True -- libgit2 0.21.2