X-Git-Url: https://git.armaanb.net/?p=lightcards.git;a=blobdiff_plain;f=README.md;h=7ceff4c953d272a8ea26985202461eaae996db0c;hp=4dd7dc9e62f960bc86207e04e1bb1bbb58b3be2f;hb=8a9fa6416484726f2c7e8386a53fbdb9e5130ed0;hpb=9eb0523ebef245793c0a61d39b25c2b66fd0699d

diff --git a/README.md b/README.md
index 4dd7dc9..7ceff4c 100644
--- 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
@@ -24,5 +26,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
+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