Add preliminary config file support

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 4dd7dc9e62f960bc86207e04e1bb1bbb58b3be2f..9284e1e212a47ea8cb765eee5f515302ca130808 100644 (file)
--- a/README.md
+++ b/README.md
@@ -24,5 +24,8 @@ 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