Implement confirm_quit config option

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index b9250f9ddbc9ff65017e25885c8fb90f600d6483..9284e1e212a47ea8cb765eee5f515302ca130808 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,31 @@
 # lightcards
 Terminal flashcards from Markdown.
 
-# Installation
-`make`
+## Installation
+### From PyPI
+```
+pip install lightcards
+```
 
-# Usage
-see `lightcards --help`
+### 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` or `man lightcards` for usage information.
+
+## 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