README.md

   1 # lightcards
   2 Terminal flashcards from Markdown.
   3
   4 ## Installation
   5 ### From PyPI
   6 ```
   7 pip install lightcards
   8 ```
   9
  10 ### From Git
  11 ```
  12 git clone https://git.sr.ht/~armaan/lightcards
  13 cd lightcards
  14 git checkout $(git tag | tail -n 1) # Dont include to use development version
  15 pip install .
  16 ```
  17
  18 ## Usage
  19 See `lightcards --help` for usage information.
  20
  21 ## Input file
  22 `contrib/example.md` is an example input file. Lightcards takes the first table from a valid Markdown or HTML file. Each row is a card, and the two columns are the front and back.
  23
  24 ## License
  25 Copyright Armaan Bhojwani 2021, MIT license