README.md

   1 # lightcards
   2 Terminal flashcards from Markdown.
   3
   4 ## Installation
   5 ### From PyPI
   6 `pip install lightcards`
   7
   8 ### From Git
   9 ```
  10 git clone https://git.sr.ht/~armaan/lightcards
  11 cd lightcards
  12 git checkout $(git tag | tail -n 1) # Don't include to use development version
  13 `pip install .`
  14 ```
  15
  16 ## Usage
  17 see `lightcards --help`
  18
  19 ## Input file
  20 See `contrib/example.md` for an example input file
  21
  22 ## License
  23 Copyright Armaan Bhojwani 2021, MIT license