onebot-qq
/
Stapxs-QQ-Lite-2.0
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases 5 Wiki Activity

Fix English README errors & typos

This commit is contained in:
Doodle Huang 2023-05-24 13:46:00 +08:00 committed by GitHub
parent 3089d34764
commit ebf45c0474
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README_en-US.md
View File

@ -25,13 +25,13 @@
![card](README/card.png)
## ✨ Supported Features
- ✅ Developed with a complete Vue.js framwork, and seperates frontend and backend
- ✅ Developed with a complete Vue.js framwork, frontend-backend seperated
- 🎨 Adaptive landscape and portrait layouts
- 🖥️ PWA support (why not just use our cool Electon app anyway)
- 🖥️ PWA support (why not just use our cool Electron app anyway)
- 🌚 Auto Light/Dark Mode
- 🍱 Includes almost everything you need!
- Sending, revoking, forwarding or replying to a message. Complex messages handled!
- Group storage (files), announcements, some group-specified settings and **essence**
- Group storage (files), announcements, some group-specified settings and **"essence"**
- Sending images, files and your favorite emotes!
- 📦️ Multiple QQ bot APIs support
- 🔥 A nice-looking Electron desktop app
@ -42,11 +42,11 @@
### > Running Services
Stapxs QQ Lite requires connecting to a QQ bot API to function properly. You can set one up by following [📖 this documentation](https://github.com/Stapxs/Stapxs-QQ-Lite-2.0/wiki/%E8%BF%9E%E6%8E%A5-oicq2-http).
### > Using the App on the go
### > Using the App On the Go
GitHub Pages is enabled and is serving a live demo [🌎 over here](https://stapxs.github.io/Stapxs-QQ-Lite-2.0).
### > Installing the App
Besides the live demo, you can also download the desktop app built with election that has more features [📦️ here](https://github.com/Stapxs/Stapxs-QQ-Lite-2.0/releases).
Besides the live demo, you can also download the desktop app built with Electron that has more features [📦️ here](https://github.com/Stapxs/Stapxs-QQ-Lite-2.0/releases).
## 💬 Tips and FAQs
@ -55,16 +55,16 @@ Besides the live demo, you can also download the desktop app built with election
### > Could I use other QQ bot APIs?
- You can give them a try if it supports the [OneBot 11 protocol](<https://github.com/botuniverse/onebot-11>). However, the differences in message body formats and extension APIs may prevent them from being fully usable.
- You can give them a try if they support the [OneBot 11 protocol](<https://github.com/botuniverse/onebot-11>). However, the differences in message body formats and extension APIs may prevent them from being fully usable.
Bot APIs supported are listed [here](https://github.com/Stapxs/Stapxs-QQ-Lite-2.0/wiki).
### > What are the risks involved in using a bot API?
- For potential risks in using oicq-http, refer to [this page](<https://github.com/takayama-lily/oicq/wiki/98.%E5%85%B3%E4%BA%8E%E8%B4%A6%E5%8F%B7%E5%86%BB%E7%BB%93%E5%92%8C%E9%A3%8E%E6%8E%A7>). If you're using other QQ bot APIs, refer to their own repositories for more infomation.
- For potential risks in using oicq-http, refer to [this page](<https://github.com/takayama-lily/oicq/wiki/98.%E5%85%B3%E4%BA%8E%E8%B4%A6%E5%8F%B7%E5%86%BB%E7%BB%93%E5%92%8C%E9%A3%8E%E6%8E%A7>). If you're using other QQ bot APIs, check out their own repositories for more infomation.
### > I have questions / problems.
- Don't hesitate to send us a [issue](<https://github.com/Stapxs/Stapxs-QQ-Lite/issues>) if you do. Bug reports and suggestions are also welcome.
- Don't hesitate to send us an [issue](<https://github.com/Stapxs/Stapxs-QQ-Lite/issues>) if you do. Bug reports and suggestions are also welcome.
## 📦️ Building the App
### > Building Webpages
@ -85,15 +85,15 @@ yarn lint
yarn build
```
### > Building the Election App
### > Building the Electron App
Starting from version `2.3.0`, Stapxs QQ Lite 2.0 can be built into an Electron app with enhanced features for some platforms. You can also build the app yourself with instructions below.
Commands for testing and building the Electron app are shown below. Artifacts will be in `dist_electron/out` folder.
``` bash
# Run local electron test
# Run local Electron test
yarn electron:serve
# Build the electron app
# Build the Electron app
yarn electron:build
```
You can also specify the desired platform with an option:
@ -113,7 +113,7 @@ yarn electron:build --linux
![3](README/pics/3.png)
## 🎉 Credits
Shoutout to my friends who have offered help in development and translation.
Shoutout to my friends who have offered help in development and translation!
<a href="https://github.com/Logic-Accepted"><img src="https://avatars.githubusercontent.com/u/36406453?s=48&v=4"></a>
<a href="https://github.com/doodlehuang"><img src="https://avatars.githubusercontent.com/u/25525621?s=48&v=4"></a>