docs: list needed programs for test
Some checks failed
build / trigger-build-image (push) Blocked by required conditions
build / build (push) Successful in 1m14s
submodules sync / sync (push) Has been cancelled

This commit is contained in:
张泊明518370910136 2024-10-19 17:18:14 -04:00
parent 312b6256c3
commit 498746dc32
GPG Key ID: D47306D7062CDA9D

View File

@ -11,6 +11,7 @@ $ git clone ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3.git
```
2. Install [Go](https://go.dev/doc/install). Also, make sure `make` and `git` are installed and all 3 programs are presented in `$PATH`.
- If you have problem on connecting to the Go website and Go packages, download Go from [studygolang](https://studygolang.com/dl) and run `go env -w GOPROXY=https://goproxy.io,direct` to set the Go modules mirror proxy after installing Go.
3. Enable cgroup v2 for your OS. For WSL2, check [here](https://stackoverflow.com/a/73376219/13724598). So that you do not need root permission to run `go-judge`.
@ -44,7 +45,14 @@ $ 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`.
For now, the following checking tools are needed for test:
1. `clang`/`clang++`
2. `clang-tidy-18`
3. `cmake`
4. `make`
5. `cpplint`
6. `cppcheck`
```bash
$ make test