Skip to content
This repository was archived by the owner on Jul 22, 2022. It is now read-only.

Commit 9751e59

Browse files
committed
Update README for the docs
1 parent d9f6ed1 commit 9751e59

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@
4848

4949

5050
## Supported processors
51+
Read the [docs](https://dockerjudge.readthedocs.io/en/latest/processor.html#module-dockerjudge.processor) for more information.
52+
5153
Processor | Language(s)\* | Required [Docker image](https://hub.docker.com/)
5254
--------- | ------------- | ------------------------------------------------
5355
`Bash` | Shell | [`bash`](https://hub.docker.com/_/bash)
@@ -67,6 +69,8 @@ Processor | Language(s)\* | Required [Docker image](https://hub.docker.com/)
6769

6870

6971
## Installation
72+
Read the [docs](https://dockerjudge.readthedocs.io/en/latest/installation.html) for more information.
73+
7074
### Docker
7175
To run `dockerjudge`, [Docker Engine](https://www.docker.com/) is required.
7276

@@ -108,6 +112,8 @@ sudo make install # python3 setup.py install
108112

109113

110114
## Usage
115+
Read the [docs](https://dockerjudge.readthedocs.io/en/latest/__init__.html) for more information.
116+
111117
```python
112118
>>> from dockerjudge import judge
113119
>>> from dockerjudge.processor import GCC, Clang, Bash, Python, Node, OpenJDK, PHP, Ruby, Mono, Swift

README.zh_Hans_CN.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@
4848

4949

5050
## 支持的处理程序
51+
阅读[文档](https://dockerjudge.readthedocs.io/zh_CN/latest/processor.html#module-dockerjudge.processor)以获取更多信息。
52+
5153
处理程序 | 语言\* | 必要的 [Docker 镜像](https://hub.docker.com/)
5254
-------- | ------ | ---------------------------------------------
5355
`Bash` | Shell | [`bash`](https://hub.docker.com/_/bash)
@@ -67,6 +69,8 @@
6769

6870

6971
## 安装
72+
阅读[文档](https://dockerjudge.readthedocs.io/zh_CN/latest/installation.html)以获取更多信息。
73+
7074
### Docker
7175
必须安装了 [Docker 引擎](https://www.docker.com/)才能运行 `dockerjudge`
7276

@@ -108,6 +112,8 @@ sudo make install # python3 setup.py install
108112

109113

110114
## 用法示例
115+
阅读[文档](https://dockerjudge.readthedocs.io/zh_CN/latest/__init__.html)以获取更多信息。
116+
111117
```python
112118
>>> from dockerjudge import judge
113119
>>> from dockerjudge.processor import GCC, Clang, Bash, Python, Node, OpenJDK, PHP, Ruby, Mono, Swift

0 commit comments

Comments
 (0)