Skip to content

Commit

Permalink
docs: add environment setup in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
address #40
  • Loading branch information
taoky committed Mar 12, 2023
1 parent 5f1c33d commit 615cd91
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,40 @@
Please include a single rst file in a [TOC tree](http://www.sphinx-doc.org/en/stable/markup/toctree.html).
For example, add a reference in `index.rst`.

## Environment setup

1. Create a virtual environment

```bash
python3 -m venv .env
```
2. Activate the virtual environment

```bash
# bash
source .env/bin/activate
# fish
source .env/bin/activate.fish
```
3. Install dependencies

```bash
pip install -r requirements.txt
```
4. Build the documents

```bash
make html
```
5. Open the documents

```bash
# macOS/fish
open build/html/index.html
# Linux
xdg-open build/html/index.html
```

## Credit

For those who improved the documents, the GitHub username will be mentioned in the
Expand Down Expand Up @@ -62,6 +96,40 @@ For those who improved the documents, the GitHub username will be mentioned in t

单个 rst 文件需要被包含在 [TOC tree](http://www.sphinx-doc.org/en/stable/markup/toctree.html) 中,例如可以在 `index.rst` 文件中添加索引。

## 环境配置

1. 创建虚拟环境

```bash
python3 -m venv .env
```
2. 激活虚拟环境

```bash
# bash
source .env/bin/activate
# fish
source .env/bin/activate.fish
```
3. 安装依赖

```bash
pip install -r requirements.txt
```
4. 构建帮助文档

```bash
make html
```
5. 查看构建的帮助文档

```bash
# macOS/fish
open build/html/index.html
# Linux
xdg-open build/html/index.html
```

## 署名

参与任何形式的贡献,相关的 GitHub 用户名会在[文档](https://mirrors.ustc.edu.cn/help/contributor.html)中提及。

0 comments on commit 615cd91

Please sign in to comment.