From eff293a336d6211672b1d76fcdb4ffe74ef233db Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Wed, 14 Jan 2026 10:21:23 +0100 Subject: Update README.md with contributing instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miquel Sabaté Solà --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3