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

Commit

Permalink
Update README for the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wxh06 committed Jul 16, 2020
1 parent d9f6ed1 commit 9751e59
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.

Expand Down Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions README.zh_Hans_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -67,6 +69,8 @@


## 安装
阅读[文档](https://dockerjudge.readthedocs.io/zh_CN/latest/installation.html)以获取更多信息。

### Docker
必须安装了 [Docker 引擎](https://www.docker.com/)才能运行 `dockerjudge`

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 9751e59

Please sign in to comment.