From c53082283a5a97f33d820ae128bf8858645182ff Mon Sep 17 00:00:00 2001 From: Boming Zhang Date: Wed, 3 Apr 2024 19:33:36 -0400 Subject: [PATCH] docs: run `make` before `make test` --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ab9e051..3997d51 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,13 @@ $ # make sure you are in JOJ3 directory $ make prepare-test ``` -7. Check the functions of `joj3` with the `make test`, which should pass all the test cases. The cases used here are in `/examples`. +7. Build binaries in `/cmd`. + +```bash +$ make +``` + +8. Check the functions of `joj3` with the `make test`, which should pass all the test cases. The cases used here are in `/examples`. Note: you may fail the test if the checking tools are not installed. e.g. For the test case `cpplint/sillycode`, you need to install `cpplint` in `/usr/bin` or `/usr/local/bin`. @@ -73,7 +79,7 @@ $ pre-commit install pre-commit installed at .git/hooks/pre-commit ``` -3. You only need to run steps 5 and 7 in the quick start during development. If the test cases need to be updated, step 6 is also needed. +3. You only need to run steps 5, 7, and 8 in the quick start during development. If the test cases need to be updated, step 6 is also needed. ## Models