本地编辑工具

前置条件: Github账户、梯子(选)

软件环境：python 3.8+、git bash、文本编辑器

1. 必要软件环境的安装

首先需要安装 git bash，直接点这里下载并运行，一路点确定就可

验证安装：在终端 cmd(1) 或 Powershell(2) 中输入 git -v 命令，返回版本信息即成功

为了能够方便地编辑多文件文档，我们推荐使用 VSCode 编辑器 (建议使用微软商城 Microsoft Store 安装，鬼知道百度出来的那一堆是神魔东西)

[就像我现在这样]

在终端界面输入如下命令安装依赖包

pip install mkdocs-material

若下载过慢可参考常见问题的 #1 ，对pip换源

1.首先打开到本项目的仓库页面，点击右上角的 Fork 按钮，将本项目克隆到你的Github账户下

2.此时你的仓库列表（Your Repositories）中会出现 tucim 的项目，点击进入，复制项目地址

3.在本地任意位置新建目录，在该目录下按 Shift + 鼠标右键 选择 使用终端打开，输入如下命令

git clone <你的项目地址>

4.如果你是首次使用git bash，会提示你输入Github账户密码，按要求输入即可
接下来等待clone操作完成

5.完成后，你的目录下会出现一个 tucim 文件夹，这就是我们的项目文件夹
接下来我们得在本地新建一个分支，输入如下命令

git checkout -b <你的分支名>

6.现在可以开始编辑文档了，编辑请参照编辑规范，完成后，我们需要将修改提交到远程仓库上，输入如下命令

git add .
git commit -m "你的提交信息"
git push origin <你的分支名>

7.完成后，你可以在你的Github仓库中看到你的修改，点击 Pull Request 按钮，提交你的修改到本项目仓库，等待我们审核即可，至此你已经完成了编辑贡献！

当本项目有更新时，你需要将本项目的更新同步到你的项目中，输入如下命令

git remote add upstream https://github.com/OpenTUC/TUCiM #(1)
git fetch upstream #(2)
git merge upstream/main #(3)