JOJ/JOJ3
24
5
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix typo

Browse Source
This commit is contained in:
张泊明518370910136 2024-03-23 18:21:13 -04:00
parent 0ee77561be
commit 2586aeace1
Signed by: 张泊明518370910136
GPG Key ID: D47306D7062CDA9D
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -2,7 +2,7 @@
## Quick Start ## Quick Start
In order to register the sandbox executor, you need to run go-judge before running this program. To register the sandbox executor, you need to run go-judge before running this program.
```bash ```bash
$ export CONF_GITEATOKEN="<YOUR_TOKEN>" && make clean && make && ./examples/success/run.sh && ./examples/compile_error/run.sh $ export CONF_GITEATOKEN="<YOUR_TOKEN>" && make clean && make && ./examples/success/run.sh && ./examples/compile_error/run.sh
@ -39,30 +39,29 @@ pre-commit installed at .git/hooks/pre-commit
``` ```
## Models ## Models
The program parses the TOML file to run multiple stages.
The program parse the TOML file to run multiple stages. Each stage contains an executor and parser.
Each stage contains a executor and parser. Executor takes a `Cmd` and returns an `ExecutorResult`.
Executor takes a `Cmd` and returns a `ExecutorResult`. Parser takes an `ExecutorResult` and its conf and returns a `ParserResult` and `bool` to indicate whether we should skip the rest stages.
Parser takes a `ExecutorResult` and its conf and returns a `ParserResult` and `bool` to indicate whether we should skip the rest stages.
### `Cmd` ### `Cmd`
Check `Cmd` in <https://github.com/criyle/go-judge#rest-api-interface>. Check `Cmd` at <https://github.com/criyle/go-judge#rest-api-interface>.
Some difference: Some difference:
- `CopyInCwd bool`: set to `true` to add everything in the current working directory to `CopyIn`. - `CopyInCwd bool`: set to `true` to add everything in the current working directory to `CopyIn`.
- `CopyInCached map[string]string`: key: file name in sandbox, value: file name used in `CopyOutCached`. - `CopyInCached map[string]string`: key: file name in the sandbox, value: file name used in `CopyOutCached`.
- `LocalFile`: now support relative path - `LocalFile`: now supports the relative path
### `ExecutorResult` ### `ExecutorResult`
Check `Result` in <https://github.com/criyle/go-judge#rest-api-interface>. Check the `Result` at <https://github.com/criyle/go-judge#rest-api-interface>.
### `ParserResult` ### `ParserResult`
- `Score int`: score of the stage. - `Score int`: score of the stage.
- `Comment string`: comment of the stage. - `Comment string`: comment on the stage.