summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2020-01-10 08:51:49 +0200
committerLars Wirzenius <liw@liw.fi>2020-01-10 08:51:49 +0200
commitb086bbe1db21da408491b284533a10abed353dd7 (patch)
treed5f52c939bc240e3db47354efcd15e2dffd0cc49 /README.md
parent35ead314dac37fabdb50f986767d0045ad0dae12 (diff)
downloadsubplot-b086bbe1db21da408491b284533a10abed353dd7.tar.gz
Add: hacking instructions to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index dcd5a88..d3156e9 100644
--- a/README.md
+++ b/README.md
@@ -19,9 +19,18 @@ the project’s acceptance criteria and how they’re verified.
See <https://subplot.liw.fi/> for the home page.
+## Hacking Subplot
+
+Subplot is written using the Rust programming language, so the usual
+workflow for Rust applies. To build run `cargo build`, to run tests in
+Rust run `cargo test`.
+
+To run the whole test suite, including testing all examples and
+Subplot self tests, run `./check` at the root of the source tree.
+
# Legalese
-Copyright 2019 Lars Wirzenius
+Copyright 2019-2020 Lars Wirzenius
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by