From: Armaan Bhojwani Date: Sat, 13 Feb 2021 19:08:40 +0000 (-0500) Subject: Update README with OS compatibility notice X-Git-Tag: v0.7.0~26 X-Git-Url: https://git.armaanb.net/?p=lightcards.git;a=commitdiff_plain;h=2b2010e3806c5c89bc25106917f231e0cebcdf5a Update README with OS compatibility notice --- diff --git a/README.md b/README.md index 84fd20b..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