From 9751e59b46cec76abe66a7836bb39816585d4089 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B1=AA=E5=BF=83=E7=A6=BE?= Date: Thu, 16 Jul 2020 13:09:33 +0800 Subject: [PATCH] Update README for the docs --- README.md | 6 ++++++ README.zh_Hans_CN.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index 5becaff..14d918d 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,8 @@ ## Supported processors +Read the [docs](https://dockerjudge.readthedocs.io/en/latest/processor.html#module-dockerjudge.processor) for more information. + Processor | Language(s)\* | Required [Docker image](https://hub.docker.com/) --------- | ------------- | ------------------------------------------------ `Bash` | Shell | [`bash`](https://hub.docker.com/_/bash) @@ -67,6 +69,8 @@ Processor | Language(s)\* | Required [Docker image](https://hub.docker.com/) ## Installation +Read the [docs](https://dockerjudge.readthedocs.io/en/latest/installation.html) for more information. + ### Docker To run `dockerjudge`, [Docker Engine](https://www.docker.com/) is required. @@ -108,6 +112,8 @@ sudo make install # python3 setup.py install ## Usage +Read the [docs](https://dockerjudge.readthedocs.io/en/latest/__init__.html) for more information. + ```python >>> from dockerjudge import judge >>> from dockerjudge.processor import GCC, Clang, Bash, Python, Node, OpenJDK, PHP, Ruby, Mono, Swift diff --git a/README.zh_Hans_CN.md b/README.zh_Hans_CN.md index ed24731..6641d97 100644 --- a/README.zh_Hans_CN.md +++ b/README.zh_Hans_CN.md @@ -48,6 +48,8 @@ ## 支持的处理程序 +阅读[文档](https://dockerjudge.readthedocs.io/zh_CN/latest/processor.html#module-dockerjudge.processor)以获取更多信息。 + 处理程序 | 语言\* | 必要的 [Docker 镜像](https://hub.docker.com/) -------- | ------ | --------------------------------------------- `Bash` | Shell | [`bash`](https://hub.docker.com/_/bash) @@ -67,6 +69,8 @@ ## 安装 +阅读[文档](https://dockerjudge.readthedocs.io/zh_CN/latest/installation.html)以获取更多信息。 + ### Docker 必须安装了 [Docker 引擎](https://www.docker.com/)才能运行 `dockerjudge`。 @@ -108,6 +112,8 @@ sudo make install # python3 setup.py install ## 用法示例 +阅读[文档](https://dockerjudge.readthedocs.io/zh_CN/latest/__init__.html)以获取更多信息。 + ```python >>> from dockerjudge import judge >>> from dockerjudge.processor import GCC, Clang, Bash, Python, Node, OpenJDK, PHP, Ruby, Mono, Swift