summaryrefslogtreecommitdiff
path: root/README.md
blob: 2d0e2b6a06dabd35e7407c1d354113071000aa5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# flashot
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

## demo
![demo](demo.mp4)

## 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?)
- [Anki](https://apps.ankiweb.net/)
- bc
- coreutils
- [dmenu](https://tools.suckless.org/dmenu/)
- [ImageMagick](https://www.imagemagick.org/)
- [maim](https://github.com/naelstrof/maim)