Update README with OS compatibility notice

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 84fd20b8b2c4042a753d245af337684858243841..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