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 #### Main branch (stable)
  12 ```
  13 pip install git+https://git.sr.ht/~armaan/lightcards
  14 ```
  15
  16 #### Development branch
  17 ```
  18 pip install git+https://git.sr.ht/~armaan/lightcards@devel
  19 ```
  20
  21 ## Usage
  22 See `lightcards --help` or `man lightcards` for usage information.
  23
  24 ## Input file
  25 `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.
  26
  27 ## Configuration
  28 Copy the config file at `/etc/lightcards/config.py` to `~/.config/lightcards/config.py` or `~/${XDG_CONFIG_HOME}/lightcards/config.py` and edit.
  29
  30 ## License
  31 Copyright Armaan Bhojwani 2021, MIT license