lirve.el/README.md

48 lines
1.0 KiB
Markdown
Raw Normal View History

2024-02-12 18:13:29 +01:00
# Lirve: Learn irregular English verbs in Emacs
Lirve helps you learn irregular verbs using the spaced repetition technique. In other words: Lirve remember your mistakes and repeat the challenge in the future.
2024-01-02 16:45:15 +01:00
![Demo](demo.png)
## Install
2024-02-12 18:13:29 +01:00
You need to have `straight` installed.
Then, add it to your `init.el`.
2024-01-02 16:45:15 +01:00
```elisp
2024-02-12 17:56:57 +01:00
(use-package learning-irregular-verbs-in-english
2024-02-12 18:13:29 +01:00
:straight (:host github :repo "tanrax/learning-irregular-verbs-in-English.el" :files ("lirve-verbs.el" "lirve.el"))
2024-01-02 16:45:15 +01:00
:ensure t)
```
2024-01-08 19:14:11 +01:00
## Configure (Optional)
Shows the translation of the verb when resolving or failing.
2024-01-08 23:10:26 +01:00
![Demo translation](demo-translation.png)
2024-02-12 18:13:29 +01:00
Only available in Spanish (at the moment).
2024-01-08 19:14:11 +01:00
```elisp
2024-02-12 17:56:57 +01:00
(setq lirve--show-translation 'es)
2024-01-08 19:14:11 +01:00
```
## Usage
```
2024-02-12 17:56:57 +01:00
M-x learning-irregular-verbs-in-english
2024-01-08 19:14:11 +01:00
```
## Controls
| Key | Description |
| --- | --- |
| `TAB` | Move to the next field |
| `S-TAB` | Move to the previous field |
| `RET` | Click on the button |
2024-02-12 18:13:29 +01:00
## Collaborate
If you want to add more languages, make a PR with the translations in `lirve-verbs.el`.