1
1
mirror of https://github.com/Yvee1/hascard.git synced 2024-11-22 12:51:58 +03:00
flashcard TUI with markdown cards
Go to file
2020-07-18 19:29:11 +02:00
app Cleaning and reorganization 2020-07-18 19:29:11 +02:00
cards Small fixes and added gifs and explantion of cards 2020-07-18 17:38:57 +02:00
recordings Small fixes and added gifs and explantion of cards 2020-07-18 17:38:57 +02:00
src Cleaning and reorganization 2020-07-18 19:29:11 +02:00
test refactored to use stack, looked at brick package 2020-01-20 10:07:16 +01:00
.gitignore refactored to use stack, looked at brick package 2020-01-20 10:07:16 +01:00
ChangeLog.md refactored to use stack, looked at brick package 2020-01-20 10:07:16 +01:00
LICENSE refactored to use stack, looked at brick package 2020-01-20 10:07:16 +01:00
package.yaml Cleaning and reorganization 2020-07-18 19:29:11 +02:00
README.md Small fixes and added gifs and explantion of cards 2020-07-18 17:38:57 +02:00
Setup.hs refactored to use stack, looked at brick package 2020-01-20 10:07:16 +01:00
stack.yaml Add centered wrapped text widget 2020-07-09 13:07:51 +02:00
stack.yaml.lock Add centered wrapped text widget 2020-07-09 13:07:51 +02:00

hascard

A commandline utility for reviewing notes. 'Flashcards' can be written in markdown-like syntax.

a recording of example usage of the hascard application

Cards

Definition

This is the simplest card, it simply has a title and can be flipped to show the contents. For example the following card

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

will result in

Multiple choice

This is a typical multiple choice question. The question starts with # and the choices follow. Only one answer is correct, and is indicated by a *, the other questions are preceded by a -. As an example, the following text

# Multiple choice question, (only one answer is right)
- Choice 1
* Choice 2 (this is the correct answer)
- Choice 3
- Choice 4

gets rendered as

Multiple answer

Multiple choice questions with multiple possible answers is also possible. Here again the question starts with # and the options follow. Preceding each option is a box [ ] that is filled with a * or a x if it is correct. For example

# Multiple answer question
[*] Option 1 (this is a correct answer)
[ ] Option 2
[*] Option 3 (this is a correct answer)
[ ] Option 4

results in

Open question

Open questions are also supported. The words that have to be filled in should be surrounded by underscores _. Multiple answer possibilities can also be given by seperating them with vertical bars |. As an example, the card

# Fill in the gaps
The symbol € is for the currency named _Euro_, and is used in the _EU|European Union_.

behaves like this

Miscellaneous info

Written in Haskell, UI built with brick and parsing of cards done with parsec. Recordings of the terminal were made using terminalizer.