Skip to content

Commit

Permalink
feat: modify README and add CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
Erindcl committed Oct 20, 2020
2 parents 21f2db0 + 0f823bc commit bac913e
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 30 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 开发指南

本文档介绍了如何进行本项目的开发。

## 本地开发

[theme 项目开发指南](./docs/react/develop.zh-CN.md)

### 项目启动&打包

```javascript
`npm install // 安装项目依赖`

`npm run dev // 启动项目`

`npm run clean // 清除 dist 目录下的静态文件`

`npm run release // 版本发布`

`npm run changelog // 生成changelog`

`npm run build // 打包项目、静态文件生成目录为当前目录的 dist`
```

## 部署

[Nginx 配置示例](./default.conf)

## 注意事项

- 模板文件路径 `./theme/static/template.html`

- 首页为空白页,需用 nginx rewrite 至指定页面

- 目前仅支持中文,如需使用其他语言请自行解决
30 changes: 0 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,36 +21,6 @@ yarn add ant-design-dtinsight-theme

[如何在数栈应用中使用](./docs/react/getting-started.zh-CN.md)

## 本地开发

[theme 项目开发指南](./docs/react/develop.zh-CN.md)

### 项目启动&打包

- `npm install // 安装项目依赖`

- `npm run dev // 启动项目`

- `npm run clean // 清除 dist 目录下的静态文件`

- `npm run release // 版本发布`

- `npm run changelog // 生成changelog`

- `npm run build // 打包项目、静态文件生成目录为当前目录的 dist`

### Nginx 配置

[Nginx 配置示例](./default.conf)

### 注意事项

- 模板文件路径 `./theme/static/template.html`

- 首页为空白页,需用 nginx rewrite 至指定页面

- 目前仅支持中文,如需使用其他语言请自行解决

## 变更记录

[更新日志](./docs/react/change-log.zh-CN.md)

0 comments on commit bac913e

Please sign in to comment.