andros/lirve.el
1
0
Fork 0
mirror of https://github.com/tanrax/lirve.el.git synced 2024-09-19 20:47:20 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Andros Fenollosa 2024-02-12 18:13:29 +01:00
parent 58499944b8
commit de6f1692bb
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,15 +1,18 @@
# Learn irregular English verbs in Emacs
## learning-irregular-verbs-in-english.el
# 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.
![Demo](demo.png)
## Install
Add in your `init.el`.
You need to have `straight` installed.
Then, add it to your `init.el`.
```elisp
(use-package learning-irregular-verbs-in-english
:straight (:host github :repo "tanrax/learning-irregular-verbs-in-English.el" :files ("lirve--verbs.el" "lirve.el"))
:straight (:host github :repo "tanrax/learning-irregular-verbs-in-English.el" :files ("lirve-verbs.el" "lirve.el"))
:ensure t)
```
@ -19,7 +22,7 @@ Shows the translation of the verb when resolving or failing.
![Demo translation](demo-translation.png)
Only available in Spanish.
Only available in Spanish (at the moment).
```elisp
(setq lirve--show-translation 'es)
@ -38,4 +41,7 @@ M-x learning-irregular-verbs-in-english
| `TAB` | Move to the next field |
| `S-TAB` | Move to the previous field |
| `RET` | Click on the button |
| `q` | Quit |
## Collaborate
If you want to add more languages, make a PR with the translations in `lirve-verbs.el`.