aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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