Fix yarn install issues & update user guide (#148)

* Fix yarn install issues & update user guide

- Fix yarn installation command
- Fix yarn packaging failure in some network environments
- Update basic user software download and installation guide

* Fix yarn issues & update user guide

* Fix yarn issues & update user guide

* update user guide

* update user guide
This commit is contained in:
Yangzheng
2024-01-18 08:12:00 +08:00
committed by GitHub
parent 2a8b1ec093
commit c7f72b35cf
11 changed files with 131 additions and 9 deletions

View File

@@ -38,12 +38,24 @@ yarn make:enjoy
方法一:这是**最直接简单的方法**是去 [releases 页面](https://github.com/xiaolai/everyone-can-use-english/tags)下载相应的安装文件。
> 如果你需要**详细下载操作指导**[点这里](find-compatible-software-version.md)
> [!TIP]
> 如果你是普通用户,并不想为本项目提供代码,按上面的操作就可以正常使用 Enjoy APP
方法二:如果想要随时**试用更新版本**的话,请按一下步骤操作。
### MacOS 用户
1. 打开命令行工具 Terminal
2. 安装 Homebrew请参阅这篇文章《[从 Terminal 开始…](https://github.com/xiaolai/apple-computer-literacy/blob/main/start-from-terminal.md)》)
3. 安装 `nodejs` 以及 `yarn`
```bash
@@ -51,7 +63,15 @@ yarn make:enjoy
nvm install 20.5.1
brew install yarn
```
4. 克隆此仓库至本地,而后安装、启动:
4. 设置 yarn 环境变量以及 Node.js 配置
```bash
export ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"
corepack enable
```
5. 克隆此仓库至本地,而后安装、启动:
```bash
cd ~
@@ -63,6 +83,8 @@ yarn make:enjoy
yarn start:enjoy
```
### Windows 用户
系统要求Windows 10 22H2 以上版本、 [Windows PowerShell 5.1](https://aka.ms/wmf5download) 以上版本、互联网网络连接正常。
@@ -73,6 +95,7 @@ yarn make:enjoy
>
> tips 2 :不能用管理员权限运行 PowerShell ,否则会导致 Scoop 安装失败
>
2. 在弹出的 PowerShell 窗口中依次执行运行以下命令安装Scoop
```powershell
@@ -86,18 +109,26 @@ yarn make:enjoy
如果出现下面的错误:
> `<span style="color:red">`irm : 未能解析此远程名称: 'raw.githubusercontent.com'
>
> <span style="color:red">irm : 未能解析此远程名称: 'raw.githubusercontent.com'</span>
说明你的**网络连接**有问题,请自行研究解决:
3. 安装 Nodejs 和 yarn 以及其他依赖环境
```powershell
scoop install nodejs
scoop install git
npm install yarn -D
npm install yarn -g
```
4. 克隆此仓库至本地,而后安装 Enjoy APP
4. 设置 yarn 环境变量以及 Node.js 配置
```powershell
$env:ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"
corepack enable
```
5. 克隆此仓库至本地,而后安装 Enjoy APP
```powershell
cd ~
@@ -105,18 +136,19 @@ yarn make:enjoy
cd github
git clone https://github.com/xiaolai/everyone-can-use-english
cd everyone-can-use-english
cd enjoy
yarn install
yarn start:enjoy
```
出现 `Completed in XXXXXXXXXX` 类似字样说明安装成功!
5. 运行 Enjoy APP ,在终端执行下列命令:
出现 `“YN0000: · Done …… ” ` 类似字样说明安装成功!
6. 运行 Enjoy APP ,在终端执行下列命令:
```powershell
yarn start:enjoy
```
## 更新Enjoy
更新并使用最新版本的Enjoy

Binary file not shown.

After

Width:  |  Height:  |  Size: 257 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 238 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 148 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 323 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 209 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 438 KiB

View File

@@ -0,0 +1,90 @@
## 如何找到适配自己电脑的软件版本
看完这篇指南,你将学会如何在 GitHub 下载软件。
[Windwos 用户点这里](#Windows用户下载以及安装)
### MacOS用户下载以及安装
点击屏幕左上方的  符号,在弹出来的菜单中,选择第一个选项 “关于本机About This Mac
<img src="find-compatible-software-version-IMG/1.png" alt="1" style="zoom:67%;" />
在弹出来的窗口中,就可以看到本机的硬软件配置:
<img src="find-compatible-software-version-IMG/2.png" alt="2" style="zoom: 50%;" />
如果你看到的画面和上面的图片类似,说明你的 Mac 是配置了 Apple M 系列M1、M2、M3的芯片这是 **ARM64 架构**的处理器,我们一会要下载 **ARM64 版本**的软件。
如果看到的画面是下面这样的,有 **Intel 字样**
<img src="find-compatible-software-version-IMG/3.jpg" alt="2" style="zoom: 50%;" />
说明你的 Mac 是 **x64 架构**,我们一会要下载 **x64 版本**的软件。
点击[这里](https://github.com/xiaolai/everyone-can-use-english/tags)跳转到 [releases 页面](https://github.com/xiaolai/everyone-can-use-english/tags)下载软件。
<img src="find-compatible-software-version-IMG/4.png" alt="2" style="zoom: 50%;" />
注意看发布的日期,**越靠前的版本越新**,我们点击 “Downloads” 跳转到下载页面
<img src="find-compatible-software-version-IMG/5.png" alt="2" style="zoom: 50%;" />
我们要下载的软件就在 Asset 里,如果 Assets 像这样,没有展开:
<img src="find-compatible-software-version-IMG/6.png" alt="2" style="zoom: 50%;" />
可以点击 “ ▶ Assets ” 旁边的 “ ▶ ” 符号展开
<img src="find-compatible-software-version-IMG/7.png" alt="2" style="zoom: 50%;" />
如果你是 **ARM 架构**的 Mac点击包含 “**darwin-arm64**” 字样的链接下载 Enjoy 程序;
如果你是 **intel 架构**的 Mac点击包含 “**darwin-x64**” 字样的链接下载 Enjoy 程序;
下载完成后,双击这个下载好的 ZIP 文件,系统会自动解压
<img src="find-compatible-software-version-IMG/8.png" alt="2" style="zoom: 50%;" />
打开 “终端” 输入
```bash
sudo xattr -rd com.apple.quarantine
```
> [!IMPORTANT]
> 注意:`sudo xattr -rd com.apple.quarantine` 这行命令后面,**要加一个 “空格”**
然后把刚才解压出来的 Enjoy 程序拖到这行命令后面
<img src="find-compatible-software-version-IMG/9.png" alt="2" style="zoom: 50%;" />
按 “return ↩ ” 键,输入电脑**登陆密码**
> 输入密码的时候屏幕上**不会有任何反馈**,这是[类 Unix](https://zh.wikipedia.org/wiki/类_Unix) 操作系统的特性
输完密码后,按 “return ↩” 键,如果终端**没有抛出任何异常**,说明赋权成功,双击软件图标就可以打开软件。
自此,你就可以正常的使用 Enjoy 软件了!
### Windows用户下载以及安装
点击[这里](https://github.com/xiaolai/everyone-can-use-english/tags)跳转到 [releases 页面](https://github.com/xiaolai/everyone-can-use-english/tags)下载软件。
<img src="find-compatible-software-version-IMG/4.png" alt="2" style="zoom: 50%;" />
注意看发布的日期,**越靠前的版本越新**,我们点击 “Downloads” 跳转到下载页面
<img src="find-compatible-software-version-IMG/5.png" alt="2" style="zoom: 50%;" />
我们要下载的软件就在 Asset 里,如果 Assets 像这样,没有展开:
<img src="find-compatible-software-version-IMG/6.png" alt="2" style="zoom: 50%;" />
可以点击 “ ▶ Assets ” 旁边的 “ ▶ ” 符号展开
<img src="find-compatible-software-version-IMG/7.png" alt="2" style="zoom: 50%;" />
点击包含 “Setup.exe” 字样的链接下载 Enjoy 安装程序,下载完成后,按向导完成安装,即可使用。