fix:update README.md

2025-08-20 00:39:44 +08:00
parent dfbd00ec1b
commit cadc279d2f
6 changed files with 108 additions and 15 deletions
--- a/.github/workflows/readme.yml
+++ b/.github/workflows/readme.yml
@@ -0,0 +1,20 @@
+name: Translate README
+
+on:
+  # 这个选项可以使你手动在 Action tab 页面触发工作流
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+      # ISO Langusge Codes: https://cloud.google.com/translate/docs/languages
+      - name: Adding README - English
+        uses: dephraiim/translate-readme@main
+        with:
+          LANG: en
--- a/Note.md
+++ b/Note.md
@@ -55,3 +55,8 @@ http://enpuz.com/ 语法分析工具

 footer 的输入数统计有问题，当在列表点一个，然后输入错误之后，不会统计到输入数里面(单词和文章的都有问题)

+nce1-16.A polite request.解析出来有问题
+
+I found this note on my car: 'Sir, we welcome you to our city. This is a 'No Parking'  area. You will enjoy your stay here if you pay attention to our street signs. This note is only a reminder.' If you receive a request like this, you cannot fail to obey it!
+
+'No Parking'  会被截断
--- a/README.md
+++ b/README.md
@@ -3,9 +3,13 @@
 </h1>

 <p align="center">
-  一个可以在网页上背单词、背文章的网站
+ <a href="docs/README.en.md">English</a> | <a href="README.md">简体中文</a> 
 </p>

+<p align="center">
+  练习英语，一次敲击，一点进步；一个可以在网页上背单词、背文章的网站，
+</p> 
+
 <p align="center">
  <a href="https://github.com/zyronon/type-word/blob/master/LICENSE"><img src="https://img.shields.io/github/license/zyronon/type-word" alt="License"></a>
  <a><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"/></a>
@@ -28,33 +32,36 @@
 ## 功能列表

 ### 背单词
+
 根据记忆曲线自动计算学习单词，并通过默写加深记忆；提供了音标、发音（美音、英音）、例句、短语、近义词、同根词、词源、错误统计等功能

 ### 背文章
+
 内置经典教材书籍，练习和背诵文章，逐句输入，自动发音。可以自行添加、导入文章，提供一键翻译、译文对照功能

 ### 收藏、错词本、已掌握
+
 学习单词时输入错误会自动添加到错词本，方便后续复习。也可以添加到已掌握，以后再遇到这个词会自动跳过，同时也可以将其添加到收藏中，以便巩固复习

 ### 词库
-内置了常用的 CET-4 、CET-6 、GMAT 、GRE 、IELTS 、SAT 、TOEFL 、考研英语、专业四级英语、专业八级英语等词库。 尽可能满足大部分用户对背单词的需求，也非常欢迎社区贡献更多的词库。

+内置了常用的 CET-4 、CET-6 、GMAT 、GRE 、IELTS 、SAT 、TOEFL 、考研英语、专业四级英语、专业八级英语等词库。
+尽可能满足大部分用户对背单词的需求，也非常欢迎社区贡献更多的词库。

-## 运行项目
+## 运行

 本项目是基于`Vue`开发的，需要 node 环境来运行。

-### 手动安装
-
 1. 安装 NodeJS，参考[官方文档](https://nodejs.org/en/download)
-2. 本项目只能使用 `git clone` 命令下载项目到本地，直接下载 Github 提供 Download ZIP 功能是无法运行的
+2. 项目文件很大，推荐使用 `git clone --depth 1 https://github.com/zyronon/TypeWords.git` 命令只克隆最近一次提交。直接下载
+   Github 提供的 Download ZIP 功能是无法运行的
 3. 打开命令行，在项目根目录下，运行`npm install`来下载依赖。
 4. 执行`npm start`来启动项目，项目默认地址为[`http://localhost:3000`](http://localhost:3000)
 5. 在浏览器中打开[`http://localhost:3000`](http://localhost:3000)  来访问项目。

 ## 功能与建议

-目前项目处于开发初期，新功能正在持续添加中，如果你对软件有任何功能与建议，欢迎在 Issues 中提出
-如果你也喜欢本软件的设计思想，欢迎提交 pr，非常感谢你对我们的支持！
+目前项目处于开发初期，新功能正在持续添加中，如果你对软件有任何功能与建议，欢迎在 `Issues` 中提出
+如果你也喜欢本软件的设计思想，欢迎提交 `pr`，非常感谢你对我们的支持！
 
 
--- a/TODO.md
+++ b/TODO.md
@@ -1,5 +0,0 @@
- nce1-16.A polite request.解析出来有问题
-
-I found this note on my car: 'Sir, we welcome you to our city. This is a 'No Parking'  area. You will enjoy your stay here if you pay attention to our street signs. This note is only a reminder.' If you receive a request like this, you cannot fail to obey it!
-
-'No Parking'  会被截断
--- a/docs/README.en.md
+++ b/docs/README.en.md
@@ -0,0 +1,67 @@
+<h1 align="center">
+  Type Words
+</h1>
+
+<p align="center">
+ <a href="docs/README.en.md">English</a> | <a href="README.md">简体中文</a> 
+</p>
+
+<p align="center">
+  练习英语，一次敲击，一点进步；一个可以在网页上背单词、背文章的网站，
+</p> 
+
+<p align="center">
+  <a href="https://github.com/zyronon/type-word/blob/master/LICENSE"><img src="https://img.shields.io/github/license/zyronon/type-word" alt="License"></a>
+  <a><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"/></a>
+  <a><img src="https://img.shields.io/badge/Powered%20by-Vue-blue"/></a>
+  <a href="https://hellogithub.com/repository/eb70616d65604458908fc1736e7d41fc" target="_blank"><img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=eb70616d65604458908fc1736e7d41fc&claim_uid=k5e4ZAqRjJEGzCW&theme=small" alt="Featured｜HelloGitHub" /></a>
+</p>
+
+<div align=center>
+<a href="https://trendshift.io/repositories/14139" target="_blank" class="trendshift-badge"><img src="https://trendshift.io/api/badge/repositories/14139" alt="TypeWords | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+</div>
+
+![image](/docs/word.png)
+![image](/docs/article.png)
+
+## 在线访问
+
+中国: <https://2study.top>   
+其他: <https://vercel.2study.top> or <https://tw.2study.top>
+
+## 功能列表
+
+### 背单词
+
+根据记忆曲线自动计算学习单词，并通过默写加深记忆；提供了音标、发音（美音、英音）、例句、短语、近义词、同根词、词源、错误统计等功能
+
+### 背文章
+
+内置经典教材书籍，练习和背诵文章，逐句输入，自动发音。可以自行添加、导入文章，提供一键翻译、译文对照功能
+
+### 收藏、错词本、已掌握
+
+学习单词时输入错误会自动添加到错词本，方便后续复习。也可以添加到已掌握，以后再遇到这个词会自动跳过，同时也可以将其添加到收藏中，以便巩固复习
+
+### 词库
+
+内置了常用的 CET-4 、CET-6 、GMAT 、GRE 、IELTS 、SAT 、TOEFL 、考研英语、专业四级英语、专业八级英语等词库。
+尽可能满足大部分用户对背单词的需求，也非常欢迎社区贡献更多的词库。
+
+## 运行
+
+本项目是基于`Vue`开发的，需要 node 环境来运行。
+
+1. 安装 NodeJS，参考[官方文档](https://nodejs.org/en/download)
+2. 项目文件很大，推荐使用 `git clone --depth 1 https://github.com/zyronon/TypeWords.git` 命令只克隆最近一次提交。直接下载
+   Github 提供的 Download ZIP 功能是无法运行的
+3. 打开命令行，在项目根目录下，运行`npm install`来下载依赖。
+4. 执行`npm start`来启动项目，项目默认地址为[`http://localhost:3000`](http://localhost:3000)
+5. 在浏览器中打开[`http://localhost:3000`](http://localhost:3000)  来访问项目。
+
+## 功能与建议
+
+目前项目处于开发初期，新功能正在持续添加中，如果你对软件有任何功能与建议，欢迎在 `Issues` 中提出
+如果你也喜欢本软件的设计思想，欢迎提交 `pr`，非常感谢你对我们的支持！
+ 
+ 
--- a/package.json
+++ b/package.json
@@ -14,8 +14,7 @@
    "commit": "git-cz",
    "prepare": "husky install",
    "i18n:write": "gulp i18nwrite",
-    "deploy-oss": "node scripts/deploy-oss.js",
-    "deploy-2": "node scripts/generate-sitemap.js"
+    "deploy-oss": "node scripts/deploy-oss.js"
  },
  "dependencies": {
    "@imengyu/vue3-context-menu": "^1.5.1",