aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 310c5de8dc9420981d2d6afa229e87d07b5b67b2 (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
33
34
35
36
# Getting started

```bash
nix develop --command bin/dev-server.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
hi : salut # Another comment
alternative 1 | alternative 2 : choix 1 | choix 2
cat (indication) : chat [ʃa]
```

# Backlog

- migrate to FSRS https://github.com/open-spaced-repetition/rs-fsrs
- Fix crashes on zoom / changing vertical size
- Get a rough idea of card learning state:
    - number of cards
    - amount of cards coming in in the following days
    - show presentation page?