From d45ffc60406d907920e9c97901af23df077d9e71 Mon Sep 17 00:00:00 2001 From: 3gf8jv4dv <3gf8jv4dv@gmail.com> Date: Sun, 29 Dec 2024 11:34:59 +0800 Subject: [PATCH] docs: revise use-source-code page (#16) --- docs/desktop/use-source-code.md | 21 ++++++++++----------- docs/mobile/use-source-code.md | 32 ++++++++++++++++---------------- 2 files changed, 26 insertions(+), 27 deletions(-) diff --git a/docs/desktop/use-source-code.md b/docs/desktop/use-source-code.md index c5b23ba6..45751191 100644 --- a/docs/desktop/use-source-code.md +++ b/docs/desktop/use-source-code.md @@ -3,18 +3,18 @@ id: use-source-code title: 源码使用方法 --- -#### 环境要求 +### 环境要求 - Node.js 16+ -#### 环境准备 +### 环境准备 -1. **安装Node.js环境（如已安装请跳过）:** 下载[Node.js](https://nodejs.org/en/)安装结束后，打开命令行输入`node -v`将会输出Node.js的版本号即表示已安装完成 -2. **安装VS build tools（如已安装请跳过）:** 下载[VS build tools](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools)安装程序后勾选 **使用 C++ 的桌面开发** 后安装即可 -3. **拉取代码:** 克隆本仓库代码 -4. **安装依赖:** 在项目根目录打开命令行，执行命令：`npm install`，若此命令执行的过程中报错可以尝试百度报错内容找解决方法 +1. **安装 Node.js 环境 (如已安装请跳过)**：下载并安装 [Node.js](https://nodejs.org/en/)，安装结束后，打开命令行输入 `node -v`，输出 Node.js 的版本号即表示已安装完成； +2. **安装 Visual Studio Build Tools (如已安装请跳过)**：下载并安装 [Visual Studio Build Tools](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools)，安装程序后勾选「使用 C++ 的桌面开发」安装即可； +3. **拉取代码**：克隆本仓库代码； +4. **安装依赖**：在项目根目录打开命令行，执行命令：`npm install`，若此命令执行的过程中报错可以尝试百度报错内容找解决方法。 -#### 开发&构建 +### 开发及构建 ```bash # 开发模式 @@ -23,13 +23,12 @@ npm run dev # 构建免安装版 npm run pack:dir -# 构建安装包（Windows版） +# 构建安装包（Windows） npm run pack:win -# 构建安装包（Mac版） +# 构建安装包（mac） npm run pack:mac -# 构建安装包（Linux版） +# 构建安装包（Linux） npm run pack:linux - ``` diff --git a/docs/mobile/use-source-code.md b/docs/mobile/use-source-code.md index 1d1cd2ac..d40cdec5 100644 --- a/docs/mobile/use-source-code.md +++ b/docs/mobile/use-source-code.md @@ -3,31 +3,31 @@ id: use-source-code title: 源码使用方法 --- -#### 环境要求 +### 环境要求 - Node.js 16+ -#### 项目环境准备 +### 项目环境准备 -1. **安装Node.js环境（如已安装请跳过）:** 下载[Node.js](https://nodejs.org/en/)安装结束后，打开命令行输入`node -v`将会输出Node.js的版本号即表示已安装完成 -2. **安装Android开发环境:** 若你没有安装有安装Android开发环境，可以看环境准备的[React Native CLI Quickstart](https://reactnative.dev/docs/environment-setup)说明 -3. **拉取代码:** 克隆本仓库代码 -4. **安装依赖:** 在项目根目录打开命令行，执行命令：`npm install`，若此命令执行的过程中报错可以尝试百度报错内容找解决方法，或在此处贴出报错日志一起讨论解决 -5. 使用Android Studio打开项目根目录下的`android`文件夹，同步一遍`gradle` +1. **安装 Node.js 环境 (如已安装请跳过)**：下载 [Node.js](https://nodejs.org/en/)，安装结束后，打开命令行输入 `node -v`，输出 Node.js 的版本号即表示已安装完成； +2. **安装 Android 开发环境**：若你没有安装 Android 开发环境，可以看环境准备的 [React Native CLI Quickstart](https://reactnative.dev/docs/environment-setup) 说明； +3. **拉取代码**：克隆本仓库代码； +4. **安装依赖**：在项目根目录打开命令行，执行命令：`npm install`，若此命令执行的过程中报错可以尝试百度报错内容找解决方法，或在 GitHub [提交 Issue](https://github.com/lyswhut/lx-music-mobile/issues?q=is%3Aissue+) 贴出报错日志一起讨论解决； +5. 使用 Android Studio 打开项目根目录下的 `android` 文件夹，同步一遍 `gradle`。 -#### 项目启动步骤 +### 项目启动步骤 -1. 启动模拟器或连接真实设备 -2. **启动开发服务器:** 在项目根目录打开命令行，执行命令：`npm run dev`，若开发服务器意外停止了，可以执行`npm start`重新启动 -3. **开发:** 修改项目下的JS即可实时看到修改后的效果 +1. 启动模拟器或连接真实设备； +2. **启动开发服务器**：在项目根目录打开命令行，执行命令：`npm run dev`，若开发服务器意外停止了，可以执行 `npm start` 重新启动； +3. **开发**：修改项目下的 JavaScript 文件即可实时看到修改后的效果。 -#### Native开发 +### Native 开发 -使用Android Studio打开项目根目录下的`android`文件夹，即可在Android Studio内进行安卓代码的开发与调试 +使用 Android Studio 打开项目根目录下的 `android` 文件夹，即可在 Android Studio 内进行 Android 代码的开发与调试。 -#### 构建安装包 +### 构建安装包 -首先生成安卓签名文件，然后将你的签名文件放在`android/app/`，然后在`android/`新建`keystore.properties`文件，填入你的签名信息： +首先生成 Android 签名文件，然后将你的签名文件放在 `android/app/`，然后在 `android/` 新建 `keystore.properties` 文件，填入你的签名信息： ```properties storeFile= @@ -36,5 +36,5 @@ keyAlias= keyPassword= ``` -最后在`android/`执行命令`./gradlew assembleRelease`，构建的安装包在`android/app/build/outputs/apk/release/` +最后在 `android/` 执行命令 `./gradlew assembleRelease`，构建的安装包在 `android/app/build/outputs/apk/release/`。