From 5a1dd2e15de2151e29edbc7949f3ddcbbba3e3b3 Mon Sep 17 00:00:00 2001 From: not_a_robot06 Date: Mon, 7 Jul 2025 17:01:32 +0100 Subject: fix README, suppress errors that are irrelevant --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) (limited to 'README.md') 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) -- cgit v1.2.3