Add menu keybindings to config

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 8c7ebd73b6a44cb4c0fc2c1a874ee4f69517a62d..7ceff4c953d272a8ea26985202461eaae996db0c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,15 +2,32 @@
 Terminal flashcards from Markdown.
 
 ## Installation
-Switch to newest version: `git checkout $(git tag | tail -n 1)`, or use the current development state.
+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.
 
-`make` to install for the current user, or `make global` to install for the whole system.
+### From PyPI
+```
+pip install lightcards
+```
+
+### From Git
+#### Main branch (stable)
+```
+pip install git+https://git.sr.ht/~armaan/lightcards
+```
+
+#### Development branch
+```
+pip install git+https://git.sr.ht/~armaan/lightcards@devel
+```
 
 ## Usage
-see `lightcards --help`
+See `lightcards --help` or `man lightcards` for usage information.
 
 ## Input file
-See `contrib/example.md` for an example input file
+`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.
+
+## Configuration
+Copy the config file at `/etc/lightcards/config.py` to `~/.config/lightcards/config.py` or `~/${XDG_CONFIG_HOME}/lightcards/config.py` and edit.
 
 ## License
 Copyright Armaan Bhojwani 2021, MIT license