Introduction

Oxycards is a quiz card application built within the terminal.

Installing and Configuring the Application

The how-to of getting this application installed, configured, and running.

• Installation
• Configuration

Installation

General Installation

After ensuring you have Rust installed, simply run the following command to install oxycards:

cargo install oxycards

To uninstall, simply run the following command:

cargo uninstall oxycards

Building Locally

1. Clone the project

  git clone https://github.com/BrookJeynes/oxycards

2. Go to the project directory

  cd oxycards

3. Create a set of cards within input.md at the projects root. See the Cards section for more information about card formatting.

4. Start the application

  cargo run

Cards

Global Formatting

Cards must be prefixed with their type. Here is a list of all available card types:

• flashcard
• multiple_choice
• multiple_answer
• fill_in_the_blanks
• order

When creating more than one card, they must be seperated by a triple dash (---).

Example

flashcard

# Word or question
Explanation or definition of this word, or the answer to the question.

---

multiple_choice

# Multiple choice question - (correct answer is denoted by an *)
* Choice 1
- Choice 2
- Choice 3
- Choice 4

---

multiple_answer

# Multiple answer question - (correct answers is denoted by an *)
[*] Option 1
[ ] Option 2
[ ] Option 3
[*] Option 4

---

fill_in_the_blanks

# Fill in the gaps
The word chook, also know as _chicken_, is a word commonly used in _AUS|Australia_.
---

order

# Order the numbers from largest to smallest - (options are placed in the correct ordering and are shuffed within the application)
1. 100000
2. 4235
3. 23
4. 6

Global Controls

Flashcards

Flashcards are the most basic cards allowing for a simple front / back description.

Formatting

The answer for the card goes beneath the header, it is allowed to span multiple lines.

Example

flashcard

# Word or question
Explanation or definition of this word, or the answer to the question.

Controls

Multiple Choice

Multiple choice cards allow the user to select a single answer given a series of options.

Formatting

Correct answers are prefixed with the star character (*)

Incorrect answers are prefixed with the dash character (-)

Example

multiple_choice

# Multiple choice question
* Choice 1
- Choice 2
- Choice 3
- Choice 4

Controls

Multiple Answer

Multiple answer cards allow the user to select any given amount of answers given a series of options.

Formatting

Correct answers are prefixed with [*]

Incorrect answers are prefixed with [ ]

Example

multiple_answer

# Multiple answer question
[*] Option 1
[ ] Option 2
[ ] Option 3
[*] Option 4

Controls

Fill in the Blanks

Fill in the blank cards allow users to enter their own answers within a series of defined blank spaces.

Formatting

Answers are surrounded by the underscore character (_), e.g. _chicken_

Multiple answers for a blank space can be defined via the pipe character (|), e.g. _AUS|Australia_

Example

fill_in_the_blanks

# Fill in the gaps
The word chook, also know as _chicken_, is a word commonly used in _AUS|Australia_.

Controls

Order

Order cards give the user a randomly sorted list of options in which they must re-sort them into the correct ordering.

Formatting

Options are written in the correct order and are shuffled within the application

Example

order

# Order the numbers from largest to smallest
1. 100000
2. 4235
3. 23
4. 6

Controls