X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=7ceff4c953d272a8ea26985202461eaae996db0c;hb=3d86d323cd351d084dd21b4530d753298fe28502;hp=d9ba139524820ccaa9d0314a037bf177fd76fc72;hpb=49c06ce42a82667180250ee97d0aceabb812f947;p=lightcards.git

diff --git a/README.md b/README.md
index d9ba139..7ceff4c 100644
--- a/README.md
+++ b/README.md
@@ -2,24 +2,32 @@
 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
 ```
 
 ### From Git
+#### Main branch (stable)
 ```
-git clone https://git.sr.ht/~armaan/lightcards
-cd lightcards
-git checkout $(git tag | tail -n 1) # Dont include to use development version
-pip install .
+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` for usage information.
+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