aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <mssola@mssola.com>2026-01-29 23:01:07 +0100
committerMiquel Sabaté Solà <mssola@mssola.com>2026-01-29 23:01:07 +0100
commit62155f9ac87e4a2bd364af1803f141b18b1d58ec (patch)
treed1f4465b32eba1e398b10dc351e5422d94289df4 /README.md
parent11acc909f5c47bf669d1a992f11437018e467638 (diff)
downloadmihi-62155f9ac87e4a2bd364af1803f141b18b1d58ec.tar.gz
mihi-62155f9ac87e4a2bd364af1803f141b18b1d58ec.zip
Update README.md file
Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/README.md b/README.md
index 2a80f89..f339046 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,26 @@
-A self assessment tool for learning languages.
-
-**UNDER CONSTRUCTION**
+A self assessment tool for learning Latin. In theory this could be expanded to
+support other language, but in earnest I don't think I will ever expand the
+scope of this anytime soon.
+
+You can manage the installation via the `init`/`nuke` commands, but to be honest
+doing so will be quite a chore considering all the forms, words, etc. to be
+entered before all of this starts to be useful. That's why I simply move around
+a backup database file (since this is all based on SQLite3). You can find a
+reasonibly-sized one at `testdata/test.sqlite3`. Just move it to your
+installation path and that should do it.
+
+You can then manage `words`, `tags` and `exercises` via their own
+commands. Finally, you run practices via the `practice` command (which is also
+the default command), which can be tweaked via multiple flags in order to tailor
+a practice session to your will.
+
+In a practice session this tool will make a best effort to ask for stuff that
+was last asked, or stuff in which you recently failed at. A word or exercise
+won't be marked as "solved for now" until it has not been marked successfully
+multiple times. Hence, there's a feel for iterating on words/exercises until you
+pass them. If you feel like you want to double down on some specific word that
+is not being asked, you can also call the `words poke` command, which will force
+the next session to ask for it.
## Contributing