# lightcards
-Lightcards is a terminal program for using flashcards from a Markdown or HTML table. It is currently under heavy development, and unusable for productive studying.
+Terminal flashcards from Markdown.
+
+## Installation
+Switch to newest version: `git checkout $(git tag | tail -n 1)`, or use the current development state.
+
+`make` to install for the current user, or `make global` to install for the whole system.
+
+## Usage
+see `lightcards --help`
+
+## Input file
+See `contrib/example.md` for an example input file
## License
Copyright Armaan Bhojwani 2021, MIT license