From cc4cd55a6697ea30d6498300b400b1a221391d55 Mon Sep 17 00:00:00 2001 From: feilong Date: Wed, 21 Sep 2022 00:28:08 +0800 Subject: [PATCH] add build doc --- README.md | 13 ++++++++----- build.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 5 deletions(-) create mode 100644 build.md diff --git a/README.md b/README.md index 2991d9b..badc048 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,14 @@ ## 如何参与贡献 * 贡献方式 - 1. fork 下面对应开放技能树编辑仓库,仔细阅读对应的仓库的README规则,新增习题或者改进已有习题 - 2. 提交 pull-request 等待审核合并 - 3. 核心贡献者会邀请加入项目仓库成员 - 4. 技能树社区将展示出题者信息,以及根据贡献值奖励一定的原力值 - 5. 参考[参与贡献Q/A](./qa.md) + * 给一个已有的技能树贡献 + 1. fork 下面对应开放技能树编辑仓库,仔细阅读对应的仓库的README规则,新增习题或者改进已有习题 + 2. 提交 pull-request 等待审核合并 + 3. 核心贡献者会邀请加入项目仓库成员 + 4. 技能树社区将展示出题者信息,以及根据贡献值奖励一定的原力值 + 5. 参考[参与贡献Q/A](./qa.md) + * 构建一个新的技能树 + * 参考[技能树项目构建练习](./build.md) * 仓库说明 * 技能森林分为`技能树开放编辑仓库`和`CSDN技能树线上社区` * 其中`技能树开放编辑仓库`采用 MIT 或者 CC4 开源协议,是开源项目仓库部分 diff --git a/build.md b/build.md new file mode 100644 index 0000000..38c72f6 --- /dev/null +++ b/build.md @@ -0,0 +1,46 @@ +# 技能树项目构建练习 + +## 预备环境 + +1. 安装 VSCode +2. 安装 Git +3. 安装 Python 3 环境 +4. 使用 pip install skill-tree-parser 安装技能树解析包 + + +## 操作步骤 + +1. 在 GitCode 上创建一个空的技能树仓库 +2. 在本地使用 git clone 克隆空的技能树仓库 +3. 使用 vscode 打开本地技能树仓库 +4. 在根目录下创建一个 main.py 文件,编写以下代码 +```python +from skill_tree.tree import TreeWalker + +if __name__ == '__main__': + walker = TreeWalker("data", "test", "Test", ignore_keywords=True) + walker.init() # 初始化代码 +``` +5. 执行命令 `python main.py` 初始化技能树目录,初始化后项目目录如下: +``` +. +├── README.md +├── data +│ ├── 1.Test初阶 +│ │ ├── 1.Test入门 +│ │ │ ├── 1.HelloWorld +│ │ │ └── config.json +│ │ └── config.json +│ ├── 2.Test中阶 +│ │ └── config.json +│ ├── 3.Test高阶 +│ │ └── config.json +│ ├── config.json +│ └── tree.json +├── main.py +└── requirements.txt +``` +6. 阅读 `README.md` +7. 提交项目到git仓库: `git add .` + `git commit -m "init"` + `git push` +8. 到技能森林仓库的「技能树孵化器」问题里,提交你的项目地址。https://gitcode.net/csdn/skill_tree/-/issues/17 +9. 找到你的伙伴,持续按照 README 的介绍持续构建技能树,构建足够好后,在技能森林仓库提交一个申请上线的 issue。https://gitcode.net/csdn/skill_tree/-/issues \ No newline at end of file -- GitLab