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. Patches will not be accepted to improve Windows support, although would be for MacOS or a BSD.
   6
   7 ### From PyPI
   8 ```
   9 pip install lightcards
  10 ```
  11
  12 ### From Git
  13 #### Main branch (stable)
  14 ```
  15 pip install git+https://git.sr.ht/~armaan/lightcards
  16 ```
  17
  18 #### Development branch
  19 ```
  20 pip install git+https://git.sr.ht/~armaan/lightcards@devel
  21 ```
  22
  23 ## Usage
  24 See `lightcards --help` or `man lightcards` for usage information.
  25
  26 ## Input file
  27 `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.
  28
  29 ## Configuration
  30 Copy the config file at `/etc/lightcards/config.py` to `~/.config/lightcards/config.py` or `~/${XDG_CONFIG_HOME}/lightcards/config.py` and edit.
  31
  32 ## License
  33 Copyright Armaan Bhojwani 2021, MIT license