Add menu keybindings to config

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 9284e1e212a47ea8cb765eee5f515302ca130808..7ceff4c953d272a8ea26985202461eaae996db0c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
 Terminal flashcards from Markdown.
 
 ## Installation
+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.
+
 ### From PyPI
 ```
 pip install lightcards
@@ -25,7 +27,7 @@ See `lightcards --help` or `man lightcards` for usage information.
 `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.
+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