From 2b2010e3806c5c89bc25106917f231e0cebcdf5a Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Sat, 13 Feb 2021 14:08:40 -0500 Subject: [PATCH] Update README with OS compatibility notice --- README.md | 2 ++ 1 file changed, 2 insertions(+) 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 -- 2.39.2