|
1 | 1 | # memotica |
2 | 2 |
|
3 | | -An easy, fast, and minimalist space repition application for the terminal |
| 3 | +An easy, fast, and minimalist space repetition application for the terminal |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- Markdown support for flashcards. |
| 10 | +- Advanced spaced repetition with the SM2 algorithm. |
| 11 | +- Keyboard-First navigation. |
| 12 | +- Easy to add, edit and delete decks and flashcards. |
| 13 | + |
| 14 | +## WIP |
| 15 | + |
| 16 | +memotica is nearly ready for use, but I there are some features that I would like to implement before reaching version `v1.0.0`: |
| 17 | + |
| 18 | +- Customizable space repetition algorithm. |
| 19 | +- Import command. |
| 20 | +- Interoperability with Anki. |
| 21 | +- Sub-decks support. |
| 22 | +- Better flashcards management. |
| 23 | +- Basic statistics. |
| 24 | +- Visual indicators. |
| 25 | + |
| 26 | +## Motivation |
| 27 | + |
| 28 | +Recently, I began to study German and a bit of Japanese. At the same time I was also playing with the idea of playing a bit more with [textual](https://textual.textualize.io/). After encountering some issues with the Anki application on Linux, I decided that it would be a great idea to create a similar application more tailored for my needs and usage. |
| 29 | + |
| 30 | +## Screenshots |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | + |
| 35 | +## Installation |
| 36 | + |
| 37 | +> memotica automatically creates a directory in the most appropriate location based on your operating system. This directory contains a SQLite database where all your decks and flashcards are stored. You can learn more about how this is done [here](https://click.palletsprojects.com/en/8.1.x/api/#click.get_app_dir). |
| 38 | +
|
| 39 | +### Using `pip` |
| 40 | + |
| 41 | +```bash |
| 42 | +pip install memotica |
| 43 | +``` |
| 44 | + |
| 45 | +### With `pipx` (recommended) |
| 46 | + |
| 47 | +```bash |
| 48 | +pipx install memotica |
| 49 | +``` |
| 50 | + |
| 51 | +## Usage |
| 52 | + |
| 53 | +Once memotica is installed, you should have the `memotica` command available. To start the TUI simply run: |
| 54 | + |
| 55 | +```bash |
| 56 | +memotica |
| 57 | +``` |
| 58 | + |
| 59 | +Or, if you want to see the help message and other available commands, run: |
| 60 | + |
| 61 | +```bash |
| 62 | +memotica --help |
| 63 | +``` |
| 64 | + |
| 65 | +Once the TUI is displayed, you can: |
| 66 | + |
| 67 | +- **Display the help message** by pressing `F1`. |
| 68 | +- **Add a new deck** by pressing `ctrl + n`. |
| 69 | +- **Add flashcards** with `ctrl+a`. |
| 70 | + |
| 71 | +After you've added flashcards, select a deck in the deck tree and press `ctrl+s` to begin the review process. |
| 72 | + |
| 73 | +## Help is Welcome |
| 74 | + |
| 75 | +If you have any suggestions or would like to contribute to this project, please feel free to open an issue. Thank for your interest! |
| 76 | + |
| 77 | +## Thanks |
| 78 | + |
| 79 | +I took inspiration and implement various aspects of memotica by reviewing and studying the source code from [harlequin.sh](https://harlequin.sh/). |
0 commit comments