From 7aa707d52596b2e2e8ba8b0fec273c533a4a1751 Mon Sep 17 00:00:00 2001 From: slhmy Date: Sun, 31 Mar 2024 15:17:43 +0800 Subject: [PATCH] Update READMEs --- README.md | 9 ++++----- judge-core/README.md | 2 -- judger/README.md | 27 --------------------------- 3 files changed, 4 insertions(+), 34 deletions(-) delete mode 100644 judger/README.md diff --git a/README.md b/README.md index 270af5b..a84209e 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,14 @@ [![Discord](https://img.shields.io/discord/916955582181822486?label=Discord&color=blue&logo=discord&logoColor=white)](https://discord.gg/vh8NCgdp8J) ![Codespace Supported](https://img.shields.io/badge/Codespace_Supported-000000?style=flat&logo=github) -Judger is supposed to be a simple **sandbox service** which works for online-judge systems. +Library & application which supports running code in a sandboxed environment. -## System +## System Prerequisite Judger currently use `nix` to make necessary system invoke like `fork()`. So you might need to check whether you are using the supported system from the main-page of [nix](https://github.com/nix-rust/nix). **Briefly speaking, judger-rs is now supposing you are decided to run it on linux.** -We'll consider other platform, but in a lower priority. ## Development @@ -28,9 +27,9 @@ There is a setup script to help you quickly get ready. ./scripts/env_setup.bash ``` -## Contribute +### Debugging -We have a guide in judger's [WIKI](https://github.com/OJ-lab/judger/wiki/Contribution-Guide) +Launch settings are already configured in `.vscode/launch.json`, try in the debug panel. ## Deeper Docs diff --git a/judge-core/README.md b/judge-core/README.md index 8e6ed8d..81abe3d 100644 --- a/judge-core/README.md +++ b/judge-core/README.md @@ -11,8 +11,6 @@ See what we've got (or plan to do) currently: - a **sandbox** mainly based on `rlimit` and `seccomp`, helps you to spawn process safely - a **monitor** (or judger) with sandboxes, enables you to run single part of judge test_case (if you got everything needed for judge) -- a **judge_builder** (WIP) to provide a higher level interface to start a judge, -supposing the judge directory structure is following [ICPC Problem Package format](https://icpc.io/problem-package-format/examples/directory_structure) ## Use strace for seccomp withlist dev diff --git a/judger/README.md b/judger/README.md deleted file mode 100644 index f88f6ed..0000000 --- a/judger/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# Judger - -## Cli - -This will be the easiest and closest way to try out the basic feature of Judger. - -### Develop Usage - -To run from the source code, try: - -``` shell -cargo run --bin judger-cli -- [COMMAND] -``` - -``` shell -cargo run --bin judger-cli -- batch-judge --help -``` - -## Server - -### How to run - -`cargo run --bin judger-server -- --env-path ./judger/src/server/environment/.env.development` - -### How to visit OpenAPI - -visit `{HOST}/swagger-ui/`