Skip to content

Commit 355c2d9

Browse files
committed
chore: update README.md
1 parent e702e38 commit 355c2d9

File tree

2 files changed

+6
-96
lines changed

2 files changed

+6
-96
lines changed

README.md

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,10 @@
11
<h1 align="center">React DevUI</h1>
22

3-
<p align="center">DevUI components based on React</p>
3+
<p align="center">UI components based on React</p>
44

55
English | [简体中文](README.zh-CN.md)
66

7-
In development.
7+
- [react-devui.com](//react-devui.com)
8+
- [admin.react-devui.com](//admin.react-devui.com)
89

910
Need unit test support (Jest) 🤝
10-
11-
## Start
12-
13-
We add `chmod ug+x .husky/` at `prepare` that make sure the files is executable in linux. So you use other OS, just ignore error.
14-
15-
Execute the following command to preview the component:
16-
17-
```
18-
yarn site:serve
19-
```
20-
21-
For non-new component contributions, please refer to [Contribution Guide](CONTRIBUTING.md).
22-
23-
## Directory Structure
24-
25-
```
26-
├── packages // Root Directory: Project
27-
│ │
28-
│ │
29-
│ ├── site // Root Directory: Website
30-
│ │ └── src
31-
│ │ ├── app
32-
│ │ │ ├── components // Components
33-
│ │ │ ├── configs // Configuration files (json)
34-
│ │ │ ├── i18n // Internationalization
35-
│ │ │ ├── routes // Routes
36-
│ │ │ └── styles // Styles
37-
│ │ ├── assets // Static resources
38-
│ │ └── environments // Configuration files in development and production environments
39-
│ │
40-
│ │
41-
│ └── ui // Root Directory: Components
42-
│ └── src
43-
│ ├── components // Components
44-
│ ├── hooks // Hooks
45-
│ ├── styles // Styles
46-
│ ├── tests // Test configuration
47-
│ └── utils // Utility function
48-
49-
50-
└── tools // Root Directory: Project Cli
51-
```
52-
53-
## VSCode configuration
54-
55-
Refer to [README.md](https://github.com/DevCloudFE/react-devui/tree/main/.vscode) under the `.vscode` directory

README.zh-CN.md

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,10 @@
11
<h1 align="center">React DevUI</h1>
22

3-
<p align="center">DevUI components based on React</p>
3+
<p align="center">基于 React 的 UI 组件库</p>
44

55
[English](README.md) | 简体中文
66

7-
开发中。
7+
- [react-devui.com](//react-devui.com)
8+
- [admin.react-devui.com](//admin.react-devui.com)
89

910
需要单元测试支持(Jest)🤝
10-
11-
## 开始
12-
13-
我们在 `prepare` 中添加 `chmod ug+x .husky/` 以确保文件在 linux 中是可执行的。 所以您使用其他操作系统,只需忽略错误。
14-
15-
执行下面的命令以预览组件:
16-
17-
```
18-
yarn site:serve
19-
```
20-
21-
非新组件贡献请参考 [贡献指南](CONTRIBUTING.md)
22-
23-
## 目录结构
24-
25-
```
26-
├── packages // 根目录:项目
27-
│ │
28-
│ │
29-
│ ├── site // 根目录:网站
30-
│ │ └── src
31-
│ │ ├── app
32-
│ │ │ ├── components // 组件
33-
│ │ │ ├── configs // 配置文件(json)
34-
│ │ │ ├── i18n // 国际化
35-
│ │ │ ├── routes // 路由
36-
│ │ │ └── styles // 样式
37-
│ │ ├── assets // 静态资源
38-
│ │ └── environments // 开发和生产环境下的配置文件
39-
│ │
40-
│ │
41-
│ └── ui // 根目录:组件
42-
│ └── src
43-
│ ├── components // 组件
44-
│ ├── hooks // Hooks
45-
│ ├── styles // 样式
46-
│ ├── tests // 测试配置
47-
│ └── utils // 实用函数
48-
49-
50-
└── tools // 根目录:项目脚手架
51-
```
52-
53-
## VSCode 配置
54-
55-
参考 `.vscode` 目录下的 [README.md](https://github.com/DevCloudFE/react-devui/tree/main/.vscode)

0 commit comments

Comments
 (0)