Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/norfairking/sparep
https://github.com/norfairking/sparep
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/norfairking/sparep
- Owner: NorfairKing
- Created: 2020-08-25T15:56:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-17T22:12:31.000Z (about 2 years ago)
- Last Synced: 2024-05-01T12:37:49.331Z (8 months ago)
- Language: Nix
- Size: 605 KB
- Stars: 8
- Watchers: 7
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Sparep: Declarative Spaced Repetition
## Usage
1. Declare decks of cards:
``` yaml
$ cat /home/user/decks/french-definite-articles.yaml
name: French definite articles
instructions: "Give the corresponding definite article for the given gramatical gender and plurality"
cards:
- front: Masculine singular
back: le
- front: Feminine singular
back: la
- front: Plural
back: les
```
See the `examples` directory for more examples.
2. Point the config file to your cards:
```
$ cat .config/sparep/config.yaml
decks:
- /home/user/decks/french-definite-articles.yaml
# or
- /home/user/decks
```
3. Study daily
```
$ sparep-tui
```
[](https://asciinema.org/a/5rvxM2QPY6ABPtnuMbjYZRv21)
Sparep takes care of showing you the right cards to study at the right time.
### Prerequisites
To play sound files, you will need to have a `play` command in your path.
You can get this from `sox`.
To show image files, you will need to have a `feh` command in your path.