From 2586aeace193c1b0e9b0a042feb59d3c32685dc7 Mon Sep 17 00:00:00 2001 From: Boming Zhang Date: Sat, 23 Mar 2024 18:21:13 -0400 Subject: [PATCH] docs: fix typo --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2ece728..c39d6a8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## 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 $ export CONF_GITEATOKEN="" && 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 +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 a `ExecutorResult` and its conf and returns a `ParserResult` and `bool` to indicate whether we should skip the rest stages. +Parser takes an `ExecutorResult` and its conf and returns a `ParserResult` and `bool` to indicate whether we should skip the rest stages. ### `Cmd` -Check `Cmd` in . +Check `Cmd` at . Some difference: - `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`. -- `LocalFile`: now support relative path +- `CopyInCached map[string]string`: key: file name in the sandbox, value: file name used in `CopyOutCached`. +- `LocalFile`: now supports the relative path ### `ExecutorResult` -Check `Result` in . +Check the `Result` at . ### `ParserResult` - `Score int`: score of the stage. -- `Comment string`: comment of the stage. +- `Comment string`: comment on the stage.