README.md

   1 # lightcards
   2 Terminal flashcards from Markdown.
   3
   4 ## Installation
   5 Lightcards is only tested and maintained on Linux. Support for other Unix-like operating systems such as MacOS and the various BSDs is likely, although untested. Windows support may be possible with [windows-curses](https://pypi.org/project/windows-curses/) or the like, however much of the program makes the assumption that there is a Unix-like file hierarchy, which may break on Windows. Nontrivial patches will not be accepted to improve Windows support, although may be for MacOS or BSD.
   6
   7 Lightcards requires Python 3.9
   8
   9 ### From PyPI
  10 ```
  11 pip install lightcards
  12 ```
  13
  14 ### From Git
  15 #### Main branch (stable)
  16 ```
  17 pip install git+https://git.sr.ht/~armaan/lightcards
  18 ```
  19
  20 #### Development branch
  21 ```
  22 pip install git+https://git.sr.ht/~armaan/lightcards@devel
  23 ```
  24
  25 ## Usage
  26 See `lightcards --help` or `man lightcards` for usage information.
  27
  28 ## Input file
  29 `contrib/example.md` is an example input file. Lightcards takes all of the tables from a valid Markdown or HTML file. Each row is a card, and the two columns are the front and back.
  30
  31 ## Configuration
  32 Copy the config file at `/etc/lightcards/config.py` to `~/.config/lightcards/config.py` or `~/${XDG_CONFIG_HOME}/lightcards/config.py` and edit.
  33
  34 ## License
  35 Copyright Armaan Bhojwani 2021, MIT license