diff --git a/README.md b/README.md index 03c9ec0..9577a2c 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,20 @@ ## Build -### 安装环境 +### Requirements 本项目需要安装 `Python` 和 `Nodejs`,执行 `pip install -r requirements.txt` 和 `npm install`。 +### Run +运行`mkdocs serve`命令,打开浏览器输入网址[http://localhost:8000](http://localhost:8000)即可看到文档 + ### Format 执行 `npm format:prettier` 会 Format 全部文件,在 `git commit` 之前也会自动执行这条命令。 +## How to contribute +参考[贡献文档](https://xdkkkgyt8c.feishu.cn/docx/LwWGdN209ofXfFxsVnQc0Q76nNc) + ## Contributor diff --git a/package-lock.json b/package-lock.json index 0e22096..a0dbf0e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "blockchainer-roadmap", + "name": "roadmap", "lockfileVersion": 3, "requires": true, "packages": {