Implement confirm_quit config option

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 9bc7879b87a73b2caa46a853538a07433b454ac7..9284e1e212a47ea8cb765eee5f515302ca130808 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,21 +3,29 @@ Terminal flashcards from Markdown.
 
 ## Installation
 ### From PyPI
-`pip install lightcards`
+```
+pip install lightcards
+```
 
 ### From Git
+#### Main branch (stable)
+```
+pip install git+https://git.sr.ht/~armaan/lightcards
 ```
-git clone https://git.sr.ht/~armaan/lightcards
-cd lightcards
-git checkout $(git tag | tail -n 1) # Don't include to use development version
-`pip install .`
+
+#### 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
+An example config file is provided at `/usr/share/doc/lightcards/config.py`, or `~/.local/share/doc/lightcards/config.py` if installed without root privileges. Copy it to `~/.config/lightcards/config.py` or `/etc/lightcards/config.py` and modify the given values.
 
 ## License
 Copyright Armaan Bhojwani 2021, MIT license