Skip to content

Commit

Permalink
fix(generator): README should be written in English (#3470)
Browse files Browse the repository at this point in the history
* fix(generator): README should be written in English

* chore: add link
  • Loading branch information
chenjiahan authored Apr 18, 2023
1 parent 08dd173 commit afea00f
Show file tree
Hide file tree
Showing 12 changed files with 62 additions and 245 deletions.
9 changes: 9 additions & 0 deletions .changeset/rare-colts-switch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
'@modern-js/module-generator': patch
'@modern-js/doc-generator': patch
'@modern-js/mwa-generator': patch
---

fix(generator): README should be written in English

fix(generator): README 应该使用英文编写
Original file line number Diff line number Diff line change
@@ -1,22 +1,33 @@
# Your Website
# Modern.js Website

{{#unless isMonorepoSubProject}}
## Prerequisites
## Setup

1. [Node.js LTS](https://github.com/nodejs/Release)
* [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)
Install the dependencies:

```bash
{{packageManager}} install
```

{{/unless}}
## Get Started

按开发环境的要求,运行和调试项目
Start the dev server:

```
{{packageManager}} dev
```

按生产环境的要求,构建项目
Build the document site for production:

```
{{packageManager}} build
```

Preview the production build locally:

```
{{packageManager}} serve
```

For more information, see the [Modern.js Doc documentation](https://modernjs.dev/doc-tools).
Original file line number Diff line number Diff line change
@@ -1,52 +1,55 @@
# Your Package
# Modern.js Package

{{#unless isMonorepoSubProject}}
## Prerequisites
## Setup

1. [Node.js LTS](https://github.com/nodejs/Release)
* [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)
Install the dependencies:

```bash
{{packageManager}} install
```

{{/unless}}
## Get Started

按开发环境的要求,运行和调试项目

运行和调试组件
Run and debug the module:

```
{{packageManager}} dev
```

运行测试用例
Run test cases:

```
{{packageManager}} test
```

{{#if isPublic}}
按照社区规范和最佳实践,生成构建产物
Build the module for production:

```
{{packageManager}} build
```

{{/if}}
继续创建更多项目要素
Enable optional features:

```
{{packageManager}} new
```

{{#unless isMonorepoSubProject}}
其他
Other commands:

```
{{packageManager}} lint # 检查和修复所有代码
{{packageManager}} lint # Lint and fix source files
{{#if isPublic}}
{{packageManager}} change # 添加 changeset,用于发版时生成 changelog
{{packageManager}} bump # 生成发版相关的修改,比如更新版本号、生成 changelog
{{packageManager}} release # 根据 bump 自动修改和人工修改的发版要求,发布项目
{{packageManager}} change # Add a new changeset
{{packageManager}} bump # Update version and changelog via changeset
{{packageManager}} release # Release the package
{{/if}}

```
{{/unless}}

For more information, see the [Modern.js Module documentation](https://modernjs.dev/module-tools/en).
Original file line number Diff line number Diff line change
@@ -1,29 +1,39 @@
# Your App

{{#unless isMonorepoSubProject}}
## Prerequisites
## Setup

1. [Node.js LTS](https://github.com/nodejs/Release)
* [Automatically call nvm use](https://github.com/nvm-sh/nvm#deeper-shell-integration)
Install the dependencies:

```bash
{{packageManager}} install
```

{{/unless}}
## Get Started

按开发环境的要求,运行和调试项目
Start the dev server:

```
{{packageManager}} dev
```

继续创建更多项目要素,比如应用入口
Enable optional features or add a new entry:

```
{{packageManager}} new
```

其他
Build the app for production:

```
{{packageManager}} build # 按生产环境的要求,构建项目
{{packageManager}} serve # 按生产环境的要求,运行项目
{{packageManager}} build
```

Preview the production build locally:

```
{{packageManager}} serve
```

For more information, see the [Modern.js documentation](https://modernjs.dev/en).
27 changes: 0 additions & 27 deletions tests/integration/app-document/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions tests/integration/async-entry/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions tests/integration/garfish/dashboard-router-v6/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions tests/integration/garfish/dashboard/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions tests/integration/garfish/main-router-v6/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions tests/integration/garfish/main/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions tests/integration/garfish/table/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions tests/integration/mwa-app/README.md

This file was deleted.

0 comments on commit afea00f

Please sign in to comment.