summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2023-10-15 11:24:43 +0300
committerLars Wirzenius <liw@liw.fi>2023-10-15 11:24:43 +0300
commit38934b2655a4943fb2eb2b023beea8a424e7c797 (patch)
treed9a56d2afa74d372b0cdb92151a9c2dfe4b84d43
parent8db5adbb441516bd81805ae6339ccad512b5670c (diff)
downloadambient-run-38934b2655a4943fb2eb2b023beea8a424e7c797.tar.gz
docs(README.md): document how to run the test suite
Signed-off-by: Lars Wirzenius <liw@liw.fi> Sponsored-by: author
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6c7f98c..1eb16d7 100644
--- a/README.md
+++ b/README.md
@@ -58,12 +58,19 @@ $ cargo build
## Testing
-To run the automated test suite, run the usual Rust command:
+To run the automated test suite, you need to first have a virtual
+machine image for Ambient. The base image for
+[ambient-build-vm](https://codeberg.org/ambient/ambient-build-vm) will
+do fine. Set the `IMAGE` environment variable to the path to that
+image when running the test suite:
~~~sh
-$ cargo test
+$ IMAGE=/path/to/base.qcow2 cargo test
~~~
+The reason the image is needed is that the test suite runs tests using
+the virtual machine, to make sure `ambient-run` works.
+
## Deployment
To create a binary to install, run: