aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <mssola@mssola.com>2026-01-14 10:21:23 +0100
committerMiquel Sabaté Solà <mssola@mssola.com>2026-01-14 10:21:23 +0100
commiteff293a336d6211672b1d76fcdb4ffe74ef233db (patch)
treef1a42e7a4f30c2cdfd2b7f6262e3f5d03f85c95e
parent8de88b5c7c41bc16a8f6979b69bbd94b7fb9b5cd (diff)
downloadmihi-eff293a336d6211672b1d76fcdb4ffe74ef233db.tar.gz
mihi-eff293a336d6211672b1d76fcdb4ffe74ef233db.zip
Update README.md with contributing instructions
Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3575913..2a80f89 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,22 @@ A self assessment tool for learning languages.
**UNDER CONSTRUCTION**
-Set the `MIHI_DATABASE` environment variable to `test.sqlite3`.
+## Contributing
+
+This application is built like any other Rust project:
+
+```
+$ cargo build
+```
+
+In order to test things you need to provide a database for it. One is provided
+in the form of `testdata/test.sqlite3`. So take that and set the `MIHI_DATABASE`
+environment variable to its full path. And after that you will be able to run:
+
+```
+$ cargo test
+$ cargo clippy --all-targets --all-features
+```
## License