Skip to content

Commit d592109

Browse files
committed
feat: update README.md for template
1 parent 03e2644 commit d592109

4 files changed

Lines changed: 97 additions & 41 deletions

File tree

temp/js/template/README.md

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,66 @@
1-
# Remax One Template
1+
# Remax {{ platformTitle }}
22

3-
使用 Remax 开发跨平台小程序的模板。
3+
{{#if one}}
4+
使用 Remax 开发跨平台小程序。
5+
{{/if}}
6+
{{#if wechat}}
7+
使用 Remax 开发微信小程序。
8+
{{/if}}
9+
{{#if toutiao}}
10+
使用 Remax 开发头条小程序。
11+
{{/if}}
12+
{{#if ali}}
13+
使用 Remax 开发阿里小程序。
14+
{{/if}}
415

5-
通过该模板创建一个新项目:
6-
7-
```bash
8-
$ create-remax-app my-app
9-
$ cd my-app
10-
```
11-
12-
## 开始开发
16+
## Getting Start
1317

1418
安装依赖
1519

1620
```bash
17-
$ npm install
21+
npm install
1822
```
1923

20-
开始构建
24+
调试项目
2125

2226
```bash
23-
# 选定要开发的平台
27+
{{#if one}}
28+
# 选定要进行开发的平台,如 wechat,并调试
2429
$ npm run dev wechat
30+
or
31+
yarn dev wechat
32+
{{else}}
33+
# 执行调试命令
34+
$ npm run dev
35+
or
36+
yarn dev
37+
{{/if}}
2538
```
2639

27-
使用小程序开发者工具打开项目根目录。
40+
{{#if one}}
41+
使用小程序开发者工具打开项目下的 `dist/[target]` 目录。
42+
{{else}}
43+
使用小程序开发者工具打开项目下的 `dist` 目录
44+
{{/if}}
2845

29-
## 发布
46+
## 构建
3047

3148
```bash
32-
# 选定要开发的平台
49+
{{#if one}}
50+
# 选定要构建的平台,如 wechat,并执行构建
3351
$ npm run build wechat
52+
or
53+
$ yarn build wechat
54+
{{else}}
55+
# 执行构建命令
56+
$ npm run build
57+
or
58+
$ yarn build
59+
{{/if}}
3460
```
3561

36-
使用小程序开发者工具上传版本。
62+
{{#if one}}
63+
使用小程序开发者工具打开项目下的 `dist/[target]` 目录,上传代码即可。
64+
{{else}}
65+
使用小程序开发者工具打开项目下的 `dist` 目录,上传代码即可。
66+
{{/if}}

temp/js/template/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
},
1919
"dependencies": {
2020
"react": "^16.12.0",
21-
"remax": "^2.0.0"
21+
"remax": "^2.0.0-alpha.14"
2222
},
2323
"devDependencies": {
24-
"cross-env": "^7.0.2",
24+
"cross-env": "^7.0.2"
2525
}
2626
}

temp/ts/template/README.md

Lines changed: 47 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,66 @@
1-
# Remax One TypeScript Template
1+
# Remax {{ platformTitle }} With TypeScript
22

3-
使用 Remax 开发跨平台小程序的 TypeScript 模板。
3+
{{#if one}}
4+
使用 Remax 开发跨平台小程序。
5+
{{/if}}
6+
{{#if wechat}}
7+
使用 Remax 开发微信小程序。
8+
{{/if}}
9+
{{#if toutiao}}
10+
使用 Remax 开发头条小程序。
11+
{{/if}}
12+
{{#if ali}}
13+
使用 Remax 开发阿里小程序。
14+
{{/if}}
415

5-
通过该模板创建一个新项目:
6-
7-
```bash
8-
$ npx degit remaxjs/template-one-typescript my-app
9-
$ cd my-app
10-
```
11-
12-
## 开始开发
16+
## Getting Start
1317

1418
安装依赖
1519

1620
```bash
17-
$ npm install
21+
npm install
1822
```
1923

20-
开始构建
24+
调试项目
2125

2226
```bash
23-
# 选定要开发的平台
24-
$ npm run dev -- wechat
25-
# 或者用 yarn
26-
$ yarn dev wechat
27+
{{#if one}}
28+
# 选定要进行开发的平台,如 wechat,并调试
29+
$ npm run dev wechat
30+
or
31+
yarn dev wechat
32+
{{else}}
33+
# 执行调试命令
34+
$ npm run dev
35+
or
36+
yarn dev
37+
{{/if}}
2738
```
2839

40+
{{#if one}}
2941
使用小程序开发者工具打开项目下的 `dist/[target]` 目录。
42+
{{else}}
43+
使用小程序开发者工具打开项目下的 `dist` 目录
44+
{{/if}}
3045

31-
## 发布
46+
## 构建
3247

3348
```bash
34-
# 选定要开发的平台
35-
$ npm run build -- wechat
36-
# 或者用 yarn
49+
{{#if one}}
50+
# 选定要构建的平台,如 wechat,并执行构建
51+
$ npm run build wechat
52+
or
3753
$ yarn build wechat
54+
{{else}}
55+
# 执行构建命令
56+
$ npm run build
57+
or
58+
$ yarn build
59+
{{/if}}
3860
```
3961

40-
使用小程序开发者工具上传版本。
62+
{{#if one}}
63+
使用小程序开发者工具打开项目下的 `dist/[target]` 目录,上传代码即可。
64+
{{else}}
65+
使用小程序开发者工具打开项目下的 `dist` 目录,上传代码即可。
66+
{{/if}}

temp/ts/template/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
},
1919
"dependencies": {
2020
"react": "^16.12.0",
21-
"remax": "^2.0.0"
21+
"remax": "^2.0.0-alpha.14"
2222
},
2323
"devDependencies": {
2424
"cross-env": "^7.0.2",

0 commit comments

Comments
 (0)