aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..2cb72af
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+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
+```