From 781b851203f8cffdc6314a3caa00c4f8f8d367c7 Mon Sep 17 00:00:00 2001 From: jiechen <1487503910@qq.com> Date: Wed, 17 Jan 2024 11:40:22 +0800 Subject: [PATCH] docs: support English readme file --- README.en-US.md | 148 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 + 2 files changed, 150 insertions(+) create mode 100644 README.en-US.md diff --git a/README.en-US.md b/README.en-US.md new file mode 100644 index 00000000..c9f50aa2 --- /dev/null +++ b/README.en-US.md @@ -0,0 +1,148 @@ +# Everyone Can Use English + +## Table of Contents + +- [Introduction](./book/README.md) +- [Chapter 1: Starting Point](./book/chapter1.md) +- [Chapter 2: Spoken Language](./book/chapter2.md) +- [Chapter 3: Pronunciation](./book/chapter3.md) +- [Chapter 4: Reading Aloud](./book/chapter4.md) +- [Chapter 5: Dictionary](./book/chapter5.md) +- [Chapter 6: Grammar](./book/chapter6.md) +- [Chapter 7: Intensive Reading](./book/chapter7.md) +- [Chapter 8: Reminders](./book/chapter8.md) +- [Afterword](./book/end.md) + +## Applications + +- [Enjoy App](./enjoy/README.md) + +## \* Developers + +### Local Setup + +```bash +yarn install +yarn start:enjoy +``` + +### Compilation + +```bash +yarn make:enjoy +``` + +## \* Everyday Users + +Method 1: The **most direct and simple method** is to download the appropriate installation file from the [releases page](https://github.com/xiaolai/everyone-can-use-english/tags). + +Method 2: If you want to **try out updated versions** at any time, follow these steps. + +### For MacOS Users + +1. Open the Terminal command line tool. +2. Install Homebrew (refer to this article: 《[从 Terminal 开始…](https://github.com/xiaolai/apple-computer-literacy/blob/main/start-from-terminal.md)》) +3. Install yarn: + + ```bash + brew install yarn + ``` + +4. Clone this repository locally and then install and launch: + + ```bash + cd ~ + mkdir github + cd github + git clone https://github.com/xiaolai/everyone-can-use-english + cd everyone-can-use-english + yarn install + yarn start:enjoy + ``` + +### For Windows Users + +System requirements: Windows 10 version 22H2 or later, [Windows PowerShell 5.1](https://aka.ms/wmf5download) or later, stable internet connection. + +1. Right-click on the "Windows logo" in the taskbar and choose "PowerShell". + + > Tips 1: On the latest Windows 11, you may not see the "PowerShell" option, only "Terminal". + > + > Tips 2: Do not run PowerShell with administrator privileges, as it may cause Scoop installation failure. + +2. In the opened PowerShell window, execute the following commands to install Scoop: + + ```powershell + + ``` + +# Set PowerShell execution policy + +Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser + +# Download installation script + +irm get.scoop.sh -outfile 'install.ps1' + +# Execute installation, --ScoopDir parameter specifies the Scoop installation path + +.\install.ps1 -ScoopDir 'C:\Scoop' + +```` + +If you encounter the error: + +> ``irm : Could not resolve this remote name: 'raw.githubusercontent.com' + +It indicates a **network connection** problem; please resolve it on your own. + +3. Install Nodejs and yarn as well as other dependencies: + +```powershell +scoop install nodejs +scoop install git +npm install yarn -D +```` + +4. Clone this repository locally, and then install the Enjoy App: + + ```powershell + cd ~ + mkdir github + cd github + git clone https://github.com/xiaolai/everyone-can-use-english + cd everyone-can-use-english + cd enjoy + yarn install + yarn start:enjoy + ``` + + If you see `Completed in XXXXXXXXXX` ,it indicates successful installation. + +5. Run the Enjoy App by executing the following command in the terminal: + +```powershell +yarn start:enjoy +``` + +## Update Enjoy + +Update and use the latest version of Enjoy: + +1. Pull the latest content from the repository locally, execute in the command line tool: + + ```bash + git pull + ``` + + The result should display: + + ```shell + Already up to date. + ``` + +2. Run the Enjoy App: + + ```shell + yarn start:enjoy + ``` diff --git a/README.md b/README.md index 52b8b623..8d595e96 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # 人人都能用英语 +中文 | [English](README.en-US.md) + ## 目录 - [简介](./book/README.md)