aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnthony Wang2024-01-02 20:06:09 -0600
committerAnthony Wang2024-01-02 20:06:09 -0600
commit33b76d4106a2024e8f095c7bbb232482b7883eee (patch)
treef79bba7bbde23cb04eaad90c388992480fe39003 /README.md
parentfdd8f1fe2d5ad5b0e09b00c919499d9fe9008c1f (diff)
Fix #1: PyQt6 and Tkinter GUIs
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9319663..6ee5021 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,11 @@ To create a card deck, use `sqlite3 cards "CREATE TABLE cards (idx INTEGER PRIMA
Now build this project with `gcc sd.c segmenttree.c -o sd -lsqlite3 -O2 -march=native` and run `./sd` to enjoy a fast flash cards experience! The program will display the `key` of a randomly selected card. Press any key to show the `val` of the card. Now press either `y` or `n` depending on whether you got the card correct, and the program adjusts that card's weight.
-If you're wondering where the name came from, this is the C port of [SD](https://git.exozy.me/a/SD), which was named after a common type of flash card. 😀
+There is also a Python GUI which requires PyQt6. Run it with `python main.py PATH_TO_SDC_BINARY`. You can optionally pass additional flags to SDC. Alternatively, there is a Tkinter GUI, `python tkinter.py PATH_TO_SD_BINARY`, that only requires the Python standard library but does not support Wayland. The GUIs are not compatible with the original unmaintained SD which lacks noninteractive mode, but it would be easy to add that to SD.
+
+It should also be fairly easy to write your own SD clone or GUI, so if you write one, I'd be glad to link to it here.
+
+If you're wondering where the name came from, this is the C port of SD, which was named after a common type of flash card. 😀
## Performance