Add sr.ht ticket tracking

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 560b692421f5d28955457c788417a5fb1e7b9e69..96a6daca86c077ac66a35ce4b6039be744b094a5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,29 @@
 # lightcards
-Lightcards is a terminal program for using flashcards from a Markdown or HTML table. Currently under development.
+Terminal flashcards from Markdown.
 
-# Installation
-`pip install .`
+## 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. Nontrivial patches will not be accepted to improve Windows support, although may be for MacOS or BSD.
+
+Lightcards requires Python 3.9
+
+### From PyPI
+```
+pip install lightcards
+```
+
+### 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
+```
+
+## Documentation
+All documentation aside from installation is included in the manpages. An online copy exists at [lightcards.armaanb.net](https://lightcards.armaanb.net/).
 
 ## License
 Copyright Armaan Bhojwani 2021, MIT license