aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fischer@muhq.space>2023-07-17 19:16:08 +0200
committerFlorian Fischer <florian.fischer@muhq.space>2023-07-17 19:16:08 +0200
commit06d5047012d79a3e986ab46598df56002d7a9e81 (patch)
tree563e66655ea9aac432fe1dc88c8defcbe11a0361
parentfc1d33eb1432ca5e64d96e6cbb8c49269ebf32a0 (diff)
downloadquiz-06d5047012d79a3e986ab46598df56002d7a9e81.tar.gz
quiz-06d5047012d79a3e986ab46598df56002d7a9e81.zip
update usage
include the help messages for the command line options.
-rw-r--r--Readme.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/Readme.md b/Readme.md
index 5b9aeaa..c26c626 100644
--- a/Readme.md
+++ b/Readme.md
@@ -17,12 +17,13 @@ The solutions file must provide the fields `question,solution`.
usage: quiz.py [-h] [-s SOLUTION_FILE] [--select SELECT] [question_dir ...]
positional arguments:
- question_dir
+ question_dir directories containing questions
options:
-h, --help show this help message and exit
-s SOLUTION_FILE, --solution-file SOLUTION_FILE
- --select SELECT
+ file containing the solutions
+ --select SELECT selector string to identify a subset of solutions
```
By default quiz.py considers the current working directory the question directory and treats all present files as questions.