From 8056f9356eaf76beb1512d106139dc28a5aee7ae Mon Sep 17 00:00:00 2001 From: "gan.jin" Date: Sun, 28 Jan 2024 20:44:50 +0800 Subject: [PATCH] docs: zh doc as default (#7) --- README.en.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 42 +++++++++++++++++++-------------------- README.zh.md | 56 ---------------------------------------------------- 3 files changed, 77 insertions(+), 77 deletions(-) create mode 100644 README.en.md delete mode 100644 README.zh.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 00000000..b6555ff1 --- /dev/null +++ b/README.en.md @@ -0,0 +1,56 @@ +[![CI](https://github.com/jinganix/guess/actions/workflows/ci.yml/badge.svg)](https://github.com/jinganix/guess/actions/workflows/ci.yml) +[![License](http://img.shields.io/:license-apache-brightgreen.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) + +# Guess + +The source code of the 'Guess Who I Am' Wechat miniprogram + +## Run + +### Backend + +#### Linux or MacOS + +```shell +git clone git@github.com:jinganix/guess.git +cd guess/service/guess +./gradlew service:guess:bootRun --args='--core.weapp.app-id=? --core.weapp.app-secret=? --core.url.db-mysql=? --spring.datasource.username=? --spring.datasource.password=?' +``` + +#### Windows + +Replace `./gradlew` with `./gradlew.bat` + +#### Description + +- core.weapp.app-id: `app-id` of the Wechat miniprogram +- core.weapp.app-secret: `app-secret` of the Wechat miniprogram +- core.url.db-mysql： Mysql connection url，e.g. `jdbc:mysql://127.0.0.1:3306/guess` +- spring.datasource.username: Mysql connection username +- spring.datasource.password: Mysql connection password + +### Frontend + +#### Execute commands + +```shell +git@github.com:jinganix/guess.git +cd guess/frontend/weapp +npm install +npm start +``` + +#### Wechat devtools + +1. Import`guess/frontend/weapp/dist` into Wechat devtools +2. Disable domain verification + + Image + +## Scan to experience + +Image + +## Contributing + +If you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started. diff --git a/README.md b/README.md index d52a025f..e8ad039e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ [![CI](https://github.com/jinganix/guess/actions/workflows/ci.yml/badge.svg)](https://github.com/jinganix/guess/actions/workflows/ci.yml) [![License](http://img.shields.io/:license-apache-brightgreen.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) -[中文文档](README.zh.md) +[English Doc](README.en.md) -# Guess +# 猜我是谁 -The source code of the 'Guess Who I Am' Wechat miniprogram +`猜我是谁`微信小程序源码 -## Run +## 运行项目 -### Backend +### 后端 -#### Linux or MacOS +#### Linux和MacOS ```shell git clone git@github.com:jinganix/guess.git @@ -21,19 +21,19 @@ cd guess/service/guess #### Windows -Replace `./gradlew` with `./gradlew.bat` +使用`./gradlew.bat`代替`./gradlew` -#### Description +#### 参数说明 -- core.weapp.app-id: `app-id` of the Wechat miniprogram -- core.weapp.app-secret: `app-secret` of the Wechat miniprogram -- core.url.db-mysql： Mysql connection url，e.g. `jdbc:mysql://127.0.0.1:3306/guess` -- spring.datasource.username: Mysql connection username -- spring.datasource.password: Mysql connection password +- core.weapp.app-id: 微信小程序的`app-id` +- core.weapp.app-secret: 微信小程序的`app-secret` +- core.url.db-mysql: mysql数据库连接地址，如`jdbc:mysql://127.0.0.1:3306/guess` +- spring.datasource.username: 数据库用户名 +- spring.datasource.password: 数据库密码 -### Frontend +### 前端 -#### Execute commands +#### 运行命令 ```shell git@github.com:jinganix/guess.git @@ -42,17 +42,17 @@ npm install npm start ``` -#### Wechat devtools +#### 开发者工具设置 -1. Import`guess/frontend/weapp/dist` into Wechat devtools -2. Disable domain verification +1. 开发者工具导入项目的dist目录：`guess/frontend/weapp/dist` +2. 关闭域名校验 Image -## Scan to experience +## 扫码体验 Image -## Contributing +## 贡献 -If you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started. +如果您有兴趣报告/修复问题并直接为代码库做出贡献，请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 获取更多信息，了解我们期望的贡献内容以及如何开始。 diff --git a/README.zh.md b/README.zh.md deleted file mode 100644 index 48490248..00000000 --- a/README.zh.md +++ /dev/null @@ -1,56 +0,0 @@ -[![CI](https://github.com/jinganix/guess/actions/workflows/ci.yml/badge.svg)](https://github.com/jinganix/guess/actions/workflows/ci.yml) -[![License](http://img.shields.io/:license-apache-brightgreen.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) - -# 猜我是谁 - -`猜我是谁`微信小程序源码 - -## 运行项目 - -### 后端 - -#### Linux和MacOS - -```shell -git clone git@github.com:jinganix/guess.git -cd guess/service/guess -./gradlew service:guess:bootRun --args='--core.weapp.app-id=? --core.weapp.app-secret=? --core.url.db-mysql=? --spring.datasource.username=? --spring.datasource.password=?' -``` - -#### Windows - -使用`./gradlew.bat`代替`./gradlew` - -#### 参数说明 - -- core.weapp.app-id: 微信小程序的`app-id` -- core.weapp.app-secret: 微信小程序的`app-secret` -- core.url.db-mysql: mysql数据库连接地址，如`jdbc:mysql://127.0.0.1:3306/guess` -- spring.datasource.username: 数据库用户名 -- spring.datasource.password: 数据库密码 - -### 前端 - -#### 运行命令 - -```shell -git@github.com:jinganix/guess.git -cd guess/frontend/weapp -npm install -npm start -``` - -#### 开发者工具设置 - -1. 开发者工具导入项目的dist目录：`guess/frontend/weapp/dist` -2. 关闭域名校验 - - Image - -## 扫码体验 - -Image - -## 贡献 - -如果您有兴趣报告/修复问题并直接为代码库做出贡献，请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 获取更多信息，了解我们期望的贡献内容以及如何开始。