Users new to command line programs are recommended to follow the complete installation instructions.
Advanced users can follow this summary:
- Ensure Python3 and Pip are installed.
git clone https://github.com/lewisforbes/Quiz-Whiz
- Run
python3 main.py
to install dependancies. - If you see
All installation requirements met.
the program is ready to be used!
The example usage walkthrough is the best way to learn how to use Quiz Whiz.
Full documentation is in the wiki.
For those simply curious of the program's capabilities, here's an over At its simplist, the program is run through the command line as follows:
python3 main.py InputFilepath --OutputType
Where --OutputType
is either --learn
or --moodle
, and InputFilepath
is the filepath to an input file of the correct format.
An example input file might look something like:
# What colour is the sky at night?
- Pink
- ^Black
- Green
# Alan Turing was a famous pianist.
- False
Which creates the following questions on Learn: