Add Python version notice

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 84fd20b8b2c4042a753d245af337684858243841..d51ee1218369c29384bc1ae3d157d82f17545b2c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,6 +2,10 @@
 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. 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