update README.md

This commit is contained in:
zyronon
2023-10-15 02:30:33 +08:00
parent 6be8ddeca9
commit af6b5c1dd2
5 changed files with 781 additions and 5 deletions

103
README.md
View File

@@ -0,0 +1,103 @@
<h1 align="center">
Typing Word
</h1>
[//]: # (<p align="center">)
[//]: # ( <a href="./docs/README_EN.md">English</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>
</p>
[//]: # (<div align=center>)
[//]: # (<img src="docs/Screenshot.png"/>)
[//]: # (</div>)
## 📸 在线访问
Netlify: <https://typing-words.netlify.app/>
## 🛠 功能列表
### 词库
内置了常用的 CET-4 、CET-6 、GMAT 、GRE 、IELTS 、SAT 、TOEFL 、考研英语、专业四级英语、专业八级英语,也有程序员常见英语单词以及多种编程语言
API 等词库。 尽可能满足大部分用户对单词记忆的需求,也非常欢迎社区贡献更多的词库。
### 音标显示、发音功能
方便用户在记忆单词时,同时记忆读音与音标。
### 默写模式
在用户完成一个章节的练习后,会弹出选项是否默写本章,方便用户巩固本章学习的单词。
### 速度、正确率显示
量化用户输入的速度和输入的正确率,让用户有感知的了解自己技能的提升
## 运行项目
本项目是基于`Vue`开发的,需要 node 环境来运行。
### 手动安装
1. 安装 NodeJS参考[官方文档](https://nodejs.org/en/download)
2. 使用 `git clone` 下载项目到本地, 不使用 git 可能因为缺少依赖而无法运行
3. 打开命令行,在项目根目录下,运行`pnpm install`来下载依赖。
4. 执行`pnpm start`来启动项目,项目默认地址为[`http://localhost:3000`](http://localhost:3000)
5. 在浏览器中打开[`http://localhost:3000`](http://localhost:3000) 来访问项目。
## 📕 词库列表
- CET-4
- CET-6
- GMAT
- GRE
- IELTS
- SAT
- TOEFL
- 考研英语
- 专业四级英语
- 专业八级英语
- Coder Dict 程序员常用词
- 高考
- 中考
- 商务英语
- BEC
- 人教版英语 3-9 年级
- 王陆雅思王听力语料库 [@Saigyouji_WKKun](https://github.com/ggehuliang)
- 日语常见词、N1 N5 [@xiaojia](https://github.com/wetery)
如果您需要背诵其他词库,欢迎在 Issue 中提出
## 📗 API 词库
- JavaScript API. [@sdu-gyf](https://github.com/sdu-gyf)
- Node.js API. [@chrysalis1215](https://github.com/chrysalis1215)
- Java API. [@darkSheep](https://github.com/SFAfreshman)
- Linux Command. [@归谜](https://github.com/vhxubo)
- C#: List API [@nidbCN](https://github.com/nidbCN)
## 🎙 功能与建议
目前项目处于开发初期,新功能正在持续添加中,如果你对软件有任何功能与建议,欢迎在 Issues 中提出
如果你也喜欢本软件的设计思想,欢迎提交 pr非常感谢你对我们的支持
### 灵感来源
[qwerty-learner](https://github.com/RealKai42/qwerty-learner/)
<br/><br/>