Yvee1/hascard
1
1
Fork 0
mirror of https://github.com/Yvee1/hascard.git synced 2024-11-26 07:30:14 +03:00
Code Issues Projects Releases Wiki Activity

Add information about including files and LaTeX in README

Browse Source
This commit is contained in:
Steven van den Broek 2020-11-14 22:58:48 +01:00 committed by GitHub
parent 35dedf9f7c
commit 048fea006b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -13,11 +13,15 @@ A minimal commandline utility for reviewing notes. 'Flashcards' can be written i
- [Installation](#installation) - [Installation](#installation)
- [Usage](#usage) - [Usage](#usage)
- [Cards](#cards) - [Cards](#cards)
- [Definition](#definition) - [Card Types](#card-types)
- [Multiple choice](#multiple-choice) - [Definition](#definition)
- [Multiple answer](#multiple-answer) - [Multiple choice](#multiple-choice)
- [Open question](#open-question) - [Multiple answer](#multiple-answer)
- [Reorder question](#reorder-question) - [Open question](#open-question)
- [Reorder question](#reorder-question)
- [Including files](#including-files)
- [LaTeX](#latex)
- [Miscellaneous info](#miscellaneous-info) - [Miscellaneous info](#miscellaneous-info)
## Installation ## Installation
@ -80,9 +84,12 @@ _de même_
with the command `hascard import input.txt output.txt -r`. More info can be found in the help text at `hascard import --help`. with the command `hascard import input.txt output.txt -r`. More info can be found in the help text at `hascard import --help`.
## Cards ## Cards
Decks of cards are written in `.txt` or `.md` files. Cards are seperated with a line containing three dashes `---`. For examples, see the [`/cards`](https://github.com/Yvee1/hascard/tree/master/cards) directory. In this section the 5 different types of cards are listed, with the syntax and how it is represented in the application. Decks of cards are written in `.txt` or `.md` files. Cards are seperated with a line containing three dashes `---`. For examples, see the [`/cards`](https://github.com/Yvee1/hascard/tree/master/cards) directory.
### Definition ### Card Types
In this section the 5 different types of cards are listed, first the text representation is given and after a gif of it is represented in the application.
#### Definition
This is the simplest card, it simply has a title and can be flipped to show the contents. For example the following card 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 # Word or question
@ -93,7 +100,7 @@ will result in
<img src="./recordings/definition.gif"></img> <img src="./recordings/definition.gif"></img>
</p> </p>
### Multiple choice #### Multiple choice
This is a typical multiple choice question. The question starts with a `#` 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 This is a typical multiple choice question. The question starts with a `#` 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
``` ```
@ -109,7 +116,7 @@ gets rendered as
<img src="./recordings/multiple-choice.gif"></img> <img src="./recordings/multiple-choice.gif"></img>
</p> </p>
### Multiple answer #### 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 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
``` ```
@ -125,7 +132,7 @@ results in
</p> </p>
### Open question #### Open question
Open questions are also supported. The words that have to be filled in should be surrounded by underscores `_`. Underscores can also be escaped by `\_` if they are part of the text, like is done in [`cards/analysis3.txt`](https://github.com/Yvee1/hascard/blob/48b5c0751ac72df791402b88c033e05488c9350d/cards/analysis3.txt#L34-L37t). Multiple answer possibilities can also be given by seperating them with vertical bars `|`. As an example, the card Open questions are also supported. The words that have to be filled in should be surrounded by underscores `_`. Underscores can also be escaped by `\_` if they are part of the text, like is done in [`cards/analysis3.txt`](https://github.com/Yvee1/hascard/blob/48b5c0751ac72df791402b88c033e05488c9350d/cards/analysis3.txt#L34-L37t). Multiple answer possibilities can also be given by seperating them with vertical bars `|`. As an example, the card
``` ```
@ -138,7 +145,7 @@ behaves like this
<img src="./recordings/gapped-question.gif"></img> <img src="./recordings/gapped-question.gif"></img>
</p> </p>
### Reorder question #### Reorder question
This is a question where you have to put the elements in the correct order. Each element is preceded by a number indicating their correct place. The elements are rendered in the same order as they are written. For example the card This is a question where you have to put the elements in the correct order. Each element is preceded by a number indicating their correct place. The elements are rendered in the same order as they are written. For example the card
``` ```
@ -153,5 +160,30 @@ will look like
<img src="./recordings/reordering.gif"></img> <img src="./recordings/reordering.gif"></img>
</p> </p>
### Including files
You might want to include an image with a question. Rendering images in the terminal itself is not well supported, so instead an option is made available to let a file be opened automatically when a question is encountered. This can for example be used to include an image or pdf, which is then opened in the default application for that file type (internally the `xdg-open` command is used for linux, and the `open` command for mac). The syntax for including files is similar to how you include images in markdown, and should be placed directly under the header. For example:
```
# What type of fruit is this?
![](pear.jpeg)
- Apple
* Pear
- Orange
- Banana
```
references the image `pear.jpeg` in the directory of the text file containing the cards. Files can be added to any of the previously listed card types.
#### LaTeX
For reviewing content with mathematical symbols, functionality is included such that LaTeX can be used. Because LaTeX cannot be rendered in the terminal directly, it is first converted to a pdf file with the `pdflatex` command (the pdf is placed in a temporary directory), and then opened in the default pdf viewer application as if the pdf were included directly like mentioned above. LaTeX can be written between three backticks, and should be placed right below the header. For example, the card
``````
# The l^p metric space
```
The space $(\ell^p, d)$ is a metric space, when $d:\ell^p \times \ell^p \rightarrow \mathbb{R}$ is defined as
$$d(x, y) = \left(\sum_{n=1}^\infty |x_n-y_n|^p\right)^{1/p}$$
```
``````
is an empty definition card and just opens a pdf file containing the mathematical statement in another window.
Note that no `\begin{document}`, `\end{document}` or `\documentclass[]{}` should be specified; this is already done automatically. The LaTeX packages "amsfonts", and "mathtools" are currently the only ones that are loaded.
## Miscellaneous info ## Miscellaneous info
Written in Haskell, UI built with [brick](https://github.com/jtdaugherty/brick) and parsing of cards done with [megaparsec](https://github.com/mrkkrp/megaparsec). Recordings of the terminal were made using [terminalizer](https://github.com/faressoft/terminalizer). The filebrowser widget was mostly copied from the brick [filebrowser demo program](https://github.com/jtdaugherty/brick/blob/master/programs/FileBrowserDemo.hs). Homebrew and Travis configurations were made much easier by [the tutorial from Chris Penner](https://chrispenner.ca/posts/homebrew-haskell). Written in Haskell, UI built with [brick](https://github.com/jtdaugherty/brick) and parsing of cards done with [megaparsec](https://github.com/mrkkrp/megaparsec). Recordings of the terminal were made using [terminalizer](https://github.com/faressoft/terminalizer). The filebrowser widget was mostly copied from the brick [filebrowser demo program](https://github.com/jtdaugherty/brick/blob/master/programs/FileBrowserDemo.hs). Homebrew and Travis configurations were made much easier by [the tutorial from Chris Penner](https://chrispenner.ca/posts/homebrew-haskell).