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

Commit 11242dd

Browse files
wxh06wxh06
committed
markdownlint
1 parent 9d4fda5 commit 11242dd

File tree

2 files changed

+40
-13
lines changed

2 files changed

+40
-13
lines changed

‎README.md‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable MD013 MD033 -->
12
<p align="center">
23
<a href="https://github.com/piterator-org">
34
<img src="https://static.piterator.com/piterator/logo.svg" alt="Piterator" width="20%">
@@ -7,6 +8,7 @@
78
</p>
89

910
# dockerjudge
11+
1012
[![Maintainability](https://api.codeclimate.com/v1/badges/dfe666a2140cd3390e56/maintainability)](https://codeclimate.com/github/wxh06/dockerjudge/maintainability)
1113
[![Python package](https://github.com/wxh06/dockerjudge/workflows/Python%20package/badge.svg)](https://github.com/wxh06/dockerjudge/actions?query=workflow%3A%22Python+package%22)
1214
[![Upload Python Package](https://github.com/wxh06/dockerjudge/workflows/Upload%20Python%20Package/badge.svg)](https://github.com/wxh06/dockerjudge/actions?query=workflow%3A%22Upload+Python+Package%22)
@@ -26,6 +28,7 @@
2628
🎌 **🇺🇸 English** | [🇨🇳 大陆简体](README.zh_Hans_CN.md)
2729

2830
**A LXC based online judge engine**, which supports [10+ programming language processors](#supported-processors):
31+
2932
- [Shell](https://en.wikipedia.org/wiki/Unix_shell)
3033
- [Bash (**B**ourne-**A**gain **sh**ell)](https://en.wikipedia.org/wiki/Bash_(Unix_shell))
3134
- [C](https://en.wikipedia.org/wiki/C_(programming_language))/[C++](https://en.wikipedia.org/wiki/C%2B%2B)
@@ -50,8 +53,8 @@
5053
- [Swift](https://swift.org/)
5154
- [`swiftc`](https://swift.org/swift-compiler/)
5255

53-
5456
## Supported processors
57+
5558
Read the [docs](https://dockerjudge.readthedocs.io/en/latest/processor.html#module-dockerjudge.processor) for more information.
5659

5760
Processor | Language(s)\* | Required [Docker image](https://hub.docker.com/)
@@ -71,41 +74,52 @@ Processor | Language(s)\* | Required [Docker image](https://hub.docker.com/)
7174

7275
**\*** The `language` argumnets of the processors which support multiple languages should be provided, or the `source` will be judged in the default language (usually C++ or C#, emboldened in the table).
7376

74-
7577
## Installation
78+
7679
Read the [docs](https://dockerjudge.readthedocs.io/en/latest/installation.html) for more information.
7780

7881
### Docker
82+
7983
To run `dockerjudge`, [Docker Engine](https://www.docker.com/) is required.
8084

8185
#### Install using the convenience script (for servers)
86+
8287
```sh
8388
curl -fsSL https://get.docker.com -o get-docker.sh
8489
sudo sh get-docker.sh
8590
```
91+
8692
See [Install Docker Engine \| Docker Documentation](https://docs.docker.com/engine/install/) for more information.
8793

8894
### Package
95+
8996
#### From the [Python Package Index (PyPI)](https://pypi.org/)
97+
9098
[dockerjudge · PyPI](https://pypi.org/project/dockerjudge/)
99+
91100
- [PyPI](https://pypi.org/simple/dockerjudge/)
92101
- [阿里巴巴开源镜像站 (Alibaba Open Source Mirror)](https://mirrors.aliyun.com/pypi/simple/dockerjudge/)
93102
- [清华大学开源软件镜像站 | Tsinghua Open Source Mirror](https://pypi.tuna.tsinghua.edu.cn/simple/dockerjudge/)
94103

95104
##### Via [pip](https://pip.pypa.io/)
105+
96106
```sh
97107
pip install dockerjudge
98108
```
99109

100110
##### Via [Easy install](https://setuptools.readthedocs.io/en/latest/easy_install.html) (deprecated)
111+
101112
```sh
102113
easy_install dockerjudge
103114
```
104115

105116
#### From [GitHub](https://github.com/)
117+
106118
[wxh06/dockerjudge: A Docker Based Online Judge Engine](https://github.com/wxh06/dockerjudge)
119+
107120
- HTTPS: `https://github.com/wxh06/dockerjudge.git`
108121
- SSH: `git@github.com:wxh06/dockerjudge.git`
122+
109123
```sh
110124
git clone https://github.com/wxh06/dockerjudge.git
111125
cd dockerjudge
@@ -114,8 +128,8 @@ make pip && make # python3 -m pip install -Ur requirements.txt && python3 setup
114128
sudo make install # python3 setup.py install
115129
```
116130

117-
118131
## Usage
132+
119133
Read the [docs](https://dockerjudge.readthedocs.io/en/latest/__init__.html) for more information.
120134

121135
```python
@@ -360,7 +374,7 @@ Read the [docs](https://dockerjudge.readthedocs.io/en/latest/__init__.html) for
360374
... Mono(Mono.Language.csharp), # C# (Mono)
361375
... b'''
362376
... using System;
363-
...
377+
...
364378
... public class HelloWorld
365379
... {
366380
... public static void Main(string[] args)
@@ -385,7 +399,7 @@ Read the [docs](https://dockerjudge.readthedocs.io/en/latest/__init__.html) for
385399
... Mono(Mono.Language.vb), # Visual Basic (Mono)
386400
... b'''
387401
... Imports System
388-
...
402+
...
389403
... Module HelloWorld
390404
... Sub Main()
391405
... Console.WriteLine("Hello World!")
@@ -417,10 +431,9 @@ Read the [docs](https://dockerjudge.readthedocs.io/en/latest/__init__.html) for
417431
]
418432
```
419433

420-
421434
## [License](LICENSE)
435+
422436
Licensed under [the **Apache License, Version 2.0**](https://www.apache.org/licenses/LICENSE-2.0)
423437
<a href="https://www.apache.org/foundation/press/kit/#wide"><img src="https://www.apache.org/foundation/press/kit/asf_logo_wide.svg" alt="Wide Apache Software Foundation Logo with Feather.svg" height="32" align="right"></a>
424438

425-
426439
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwxh06%2Fdockerjudge.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fwxh06%2Fdockerjudge?ref=badge_large)

‎README.zh_Hans_CN.md‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable MD013 MD033 -->
12
<p align="center">
23
<a href="https://github.com/piterator-org">
34
<img src="https://static.piterator.com/piterator/logo.svg" alt="Piterator" width="20%">
@@ -7,6 +8,7 @@
78
</p>
89

910
# dockerjudge
11+
1012
[![Maintainability](https://api.codeclimate.com/v1/badges/dfe666a2140cd3390e56/maintainability)](https://codeclimate.com/github/wxh06/dockerjudge/maintainability)
1113
[![Python 包](https://github.com/wxh06/dockerjudge/workflows/Python%20package/badge.svg)](https://github.com/wxh06/dockerjudge/actions?query=workflow%3A%22Python+package%22)
1214
[![上传 Python 包](https://github.com/wxh06/dockerjudge/workflows/Upload%20Python%20Package/badge.svg)](https://github.com/wxh06/dockerjudge/actions?query=workflow%3A%22Upload+Python+Package%22)
@@ -26,6 +28,7 @@
2628
🎌 [🇺🇸 English](README.md) | **🇨🇳 大陆简体**
2729

2830
**基于 LXC 的在线测评引擎**，支持 [10+ 个编程语言处理程序](#支持的处理程序)：
31+
2932
- [Shell](https://zh.wikipedia.org/zh-cn/Unix_shell)
3033
- [Bash (**B**ourne-**A**gain **sh**ell)](https://zh.wikipedia.org/zh-cn/Bash)
3134
- [C](https://zh.wikipedia.org/zh-cn/C语言)/[C++](https://zh.wikipedia.org/zh-cn/C%2B%2B)
@@ -50,8 +53,8 @@
5053
- [Swift](https://swift.org/)
5154
- [`swiftc`](https://swift.org/swift-compiler/)
5255

53-
5456
## 支持的处理程序
57+
5558
阅读[文档](https://dockerjudge.readthedocs.io/zh_CN/latest/processor.html#module-dockerjudge.processor)以获取更多信息。
5659

5760
处理程序 | 语言\* | 必要的 [Docker 镜像](https://hub.docker.com/)
@@ -71,41 +74,52 @@
7174

7275
**\*** 应该向多语言处理器提供 `language` 参数，否则将以默认语言（通常是 C++ 或 C#，表格中加粗的）对 `source` 进行测评。
7376

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

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

8185
#### 用简便脚本安装（服务器端）
86+
8287
```sh
8388
curl -fsSL https://get.docker.com -o get-docker.sh
8489
sudo sh get-docker.sh
8590
```
91+
8692
更多信息，请参阅 [Install Docker Engine \| Docker Documentation（英文）](https://docs.docker.com/engine/install/)。
8793

8894
### 包
95+
8996
#### 从 [Python 包索引 (PyPI)](https://pypi.org/)
97+
9098
[dockerjudge · PyPI](https://pypi.org/project/dockerjudge/)
99+
91100
- [PyPI](https://pypi.org/simple/dockerjudge/)
92101
- [阿里巴巴开源镜像站](https://mirrors.aliyun.com/pypi/simple/dockerjudge/)
93102
- [清华大学开源软件镜像站 | Tsinghua Open Source Mirror](https://pypi.tuna.tsinghua.edu.cn/simple/dockerjudge/)
94103

95104
##### 通过 [pip](https://pip.pypa.io/)
105+
96106
```sh
97107
pip install dockerjudge
98108
```
99109

100110
##### 通过 [Easy install](https://setuptools.readthedocs.io/en/latest/easy_install.html) (不建议)
111+
101112
```sh
102113
easy_install dockerjudge
103114
```
104115

105116
#### 从 [GitHub](https://github.com/)
117+
106118
[wxh06/dockerjudge: A Docker Based Online Judge Engine](https://github.com/wxh06/dockerjudge)
119+
107120
- HTTPS: `https://github.com/wxh06/dockerjudge.git`
108121
- SSH: `git@github.com:wxh06/dockerjudge.git`
122+
109123
```sh
110124
git clone https://github.com/wxh06/dockerjudge.git
111125
cd dockerjudge
@@ -114,8 +128,8 @@ make pip && make # python3 -m pip install -Ur requirements.txt && python3 setup
114128
sudo make install # python3 setup.py install
115129
```
116130

117-
118131
## 用法示例
132+
119133
阅读[文档](https://dockerjudge.readthedocs.io/zh_CN/latest/__init__.html)以获取更多信息。
120134

121135
```python
@@ -360,7 +374,7 @@ sudo make install # python3 setup.py install
360374
... Mono(Mono.Language.csharp), # C# (Mono)
361375
... b'''
362376
... using System;
363-
...
377+
...
364378
... public class HelloWorld
365379
... {
366380
... public static void Main(string[] args)
@@ -385,7 +399,7 @@ sudo make install # python3 setup.py install
385399
... Mono(Mono.Language.vb), # Visual Basic (Mono)
386400
... b'''
387401
... Imports System
388-
...
402+
...
389403
... Module HelloWorld
390404
... Sub Main()
391405
... Console.WriteLine("Hello World!")
@@ -417,7 +431,7 @@ sudo make install # python3 setup.py install
417431
]
418432
```
419433

420-
421434
## [许可协议](LICENSE)
435+
422436
以 [**Apache License 2.0**](https://www.apache.org/licenses/LICENSE-2.0) 进行授权
423437
<a href="https://www.apache.org/foundation/press/kit/#wide"><img src="https://www.apache.org/foundation/press/kit/asf_logo_wide.svg" alt="Wide Apache Software Foundation Logo with Feather.svg" height="32" align="right"></a>

0 commit comments

Comments
 (0)