Skip to content

Commit e4ec968

Browse files
Added a readme to the Regular Expressions quiz.
1 parent 6565316 commit e4ec968

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

quizzes/regex/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Regular Expressions Quiz
2+
3+
This is a fully functional quiz about regular expressions.
4+
This quiz is a companion to the [Regular Expressions Assignment](/assignments/regex).
5+
6+
This quiz also serves as a good demonstration of the [Quiz Composer](https://github.com/edulinq/quiz-composer),
7+
as it covers all the primary question types.
8+
9+
Questions for this quiz live in the [questions directory](./questions),
10+
and the quiz itself is represented with the [quiz.json](./quiz.json) file.
11+
12+
A compiled PDF version of the quiz is available as [quiz.pdf](./quiz.pdf).
13+
14+
## Working with the Quiz
15+
16+
There are many things you can do with this quiz using the [Quiz Composer](https://github.com/edulinq/quiz-composer) Python library.
17+
Here we will highlight a few of the commands.
18+
See the repository for more specifics.
19+
20+
These commands all assume that you have the Quiz Composer installed
21+
and are running the commands from this directory.
22+
23+
Compile to HTML:
24+
```sh
25+
python3 -m quizcomp.cli.parse.quiz quiz.json --format html > quiz.html
26+
```
27+
28+
Compile to TeX:
29+
```sh
30+
python3 -m quizcomp.cli.parse.quiz quiz.json --format tex > quiz.tex
31+
```
32+
33+
Create a PDF:
34+
```sh
35+
python3 -m quizcomp.cli.pdf.create quiz.json
36+
```
37+
38+
Upload to Canvas:
39+
```sh
40+
python3 -m quizcomp.cli.canvas.upload quiz.json --course <canvas course id> --token <canvas access token>
41+
```
42+
43+
Upload to GradeScope:
44+
```sh
45+
python3 -m quizcomp.cli.gradescope.upload quiz.json --course <course id> --user <username> --pass <password>
46+
```

0 commit comments

Comments
 (0)