]> git.armaanb.net Git - lightcards.git/blob - README.md
Update README
[lightcards.git] / README.md
1 # lightcards
2 Terminal flashcards from Markdown.
3
4 ## Installation
5 Switch to newest version: `git checkout $(git tag | tail -n 1)`, or use the current development state.
6
7 `make` to install for the current user, or `make global` to install for the whole system.
8
9 ## Usage
10 see `lightcards --help`
11
12 ## Input file
13 See `contrib/example.md` for an example input file
14
15 ## License
16 Copyright Armaan Bhojwani 2021, MIT license