50 lines
1.3 KiB
Cheetah
50 lines
1.3 KiB
Cheetah
|
{{define "description"}}
|
||
|
# Probo
|
||
|
|
||
|
`probo` is a quiz management system designed for command line
|
||
|
enthusiasts. `probo` aims to highlight themes such as privacy,
|
||
|
interoperability, accessibility, decentralization, and quick usage
|
||
|
speed.
|
||
|
|
||
|
`probo` organizes information in plain text files and folders so that
|
||
|
data can be easily revised through version control systems.
|
||
|
|
||
|
`probo` contains a built-in web server that allows quizzes to be
|
||
|
administered to participants and their answers received.
|
||
|
|
||
|
`probo` is a self-contained application that can be distributed through
|
||
|
a simple executable containing all necessary assets for its operation.
|
||
|
|
||
|
# Quickstart
|
||
|
|
||
|
1. Initialize the working directory. The command will build a scaffold
|
||
|
containing example participants, quizzes, and filters
|
||
|
|
||
|
```
|
||
|
probo init
|
||
|
```
|
||
|
|
||
|
2. Filter participants and quizzes and create an exam
|
||
|
session.
|
||
|
|
||
|
```
|
||
|
probo filter participant -i data/filters/9th_grade.jq \
|
||
|
| probo filter quizzes -i data/filters/difficult_easy.jq \
|
||
|
| probo create session --name="My First Session" > data/sessions/my_session.json
|
||
|
```
|
||
|
|
||
|
3. Run the web server to allow participants to respond.
|
||
|
|
||
|
```
|
||
|
probo serve
|
||
|
```
|
||
|
|
||
|
4. Share the *qrcode* generated from the previous step with the
|
||
|
participants and wait for them to finish responding.
|
||
|
|
||
|
5. Explore the results.
|
||
|
|
||
|
```
|
||
|
probo filter responses -f '.' | probo rank
|
||
|
```
|
||
|
{{end}}
|