cosmetics
[qomet.git] / README.md
index d79ff0d..845524b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,12 @@
-# qomet
+# qomet - WARNING: prototype stage
 
 ### Questions Ouvertes ou à options Multiples pour l'Évaluation des éTudiants
 
-Or "... pour Examens sur inTernet", in french.
+Or "... pour Examens sur inTernet", in french. In english, just revert the acronym:
 
-In english, just revert the acronym:
-"sTudents Evaluation with Multiple chOices or Open Questions (or ...inTernet Exams with).
+"sTudents Evaluation with Multiple choices or Open Questions (or ...inTernet Exams with).
+
+Source code of [qomet.auder.net](https://qomet.auder.net)
 
 ## Features
 
@@ -15,8 +16,8 @@ Individual answers to an exam are monitored in real time, and feedback is sent
 to each participant in the end (answers, computing grade).
 Once a series of exam is over, the teacher can get all grades in CSV format from course page.
 
-*Note:* for now the monitoring + socket part is still unimplemented,
-and exams composition is limited to single question exercises.
+*Note:* for now exams composition is limited to single question exercises.
+Automatic grades are also not available.
 
 ## Installation
 
@@ -30,16 +31,16 @@ TODO: write tutorial, maybe a demo video.
 Once an assessment is started, it's impossible to quit and restart using another browser,
 because a password stored in cookies need to be sent with every request.
 So under normal circumstances it's also impossible for a student to continue the exam of another.
-(The password is destroyed when exam ends or when the teacher decide to finish assessment).
+(The password is destroyed when exam ends or when the teacher decides to finish assessment).
 
 ## Limitations
 
 Version "standard classroom": some potential cheating ways,
  - headless browsers with renamed http-user-agent; difficult to counter with 100% confidence
- - block JS script using e.g. μblock, then re-inject the script cleaned of listeners
+ - block JS script using e.g. [uBlock Origin](https://github.com/gorhill/uBlock), then re-inject the script cleaned of listeners
  - intercept HTTP response to "start quiz" signal, re-compose the page without listeners and run
 
-The only way to garanty 0 internet cheat is to use some SELinux configuration in kiosk mode
+The only way to garanty zero internet cheat is to use some SELinux configuration in kiosk mode
 with just one safe web browser enabled, e.g. [surf](https://surf.suckless.org/).
 Not that more traditional ways of cheating may still be used (phones, talking, signs, memos...)