summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authornot_a_robot06 <temporarythrowaway@tutamail.com>2025-07-07 17:01:32 +0100
committernot_a_robot06 <temporarythrowaway@tutamail.com>2025-07-07 17:01:32 +0100
commit5a1dd2e15de2151e29edbc7949f3ddcbbba3e3b3 (patch)
tree9f38149ec1394705ea95f0c2b7bcd074363fee07 /README.md
parentbe35de785e659cc080dd902cf296b5ce270e2e3f (diff)
downloadflashot-5a1dd2e15de2151e29edbc7949f3ddcbbba3e3b3.tar.gz
flashot-5a1dd2e15de2151e29edbc7949f3ddcbbba3e3b3.tar.bz2
flashot-5a1dd2e15de2151e29edbc7949f3ddcbbba3e3b3.zip
fix README, suppress errors that are irrelevant
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 19 insertions, 5 deletions
diff --git a/README.md b/README.md
index 5b9381e..addcdbc 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,27 @@
make flashcards out of screenshots, without any manual dragging and dropping!
multiple screenshots for one side of a flashcard? no problem!
-very useful for turning exam paper questions and answers into flashcards, effortlessly
+very useful for turning exam paper questions and answers into flashcards,
+effortlessly
+
+## usage
+### flashot.sh
+- will prompt for name of flashcard collection
+- then prompts for number and type of card, then allows you to take a
+ screenshot
+- no environment variables or commandline arguments
+
+### flashot-make.sh
+- prompts to combine screenshots and import into anki, or to remove all current
+ screenshots
+- environment variable `FLASHOT_ANKI_USER` defines which anki user to copy
+ screenshots to; default is "Main"
## dependencies
- *nix system with X (wayland support later?)
-- [https://apps.ankiweb.net/](Anki)
+- [Anki](https://apps.ankiweb.net/)
- bc
- coreutils
-- [https://tools.suckless.org/dmenu/](dmenu)
-- [https://www.imagemagick.org/](ImageMagick)
-- [https://github.com/resurrecting-open-source-projects/scrot](scrot)
+- [dmenu](https://tools.suckless.org/dmenu/)
+- [ImageMagick](https://www.imagemagick.org/)
+- [scrot](https://github.com/resurrecting-open-source-projects/scrot)