aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1a20b8ea214d9cb449ccefce050c4a5408650ecb (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
32
# Getting started

```bash
nix develop --command bin/watch.sh
```

# Screenshot

![Screenshot](screenshot.png)

# Space repetition algorithm

The SM2 algorithm used by Anki has been implemented for space repetition. See
[src/space_repetition.rs](src/space_repetition.rs).

# Deck

Cards are created from a plain text `./deck` file:

```
# This is a comment

- good moorning : bonjour
- alternative 1 | alternative 2 : choix 1 | choix 2
- cat (indication) : chat
```

# Backlog

- Fix crashes on zoom / changing vertical size
- Show a message when the deck can’t be read
- Get a rough idea of card learning state