Skip to content

Commit

Permalink
docs: update README in Chinese
Browse files Browse the repository at this point in the history
  • Loading branch information
ZZHow1024 committed Feb 9, 2025
1 parent addbcf5 commit 544a8f4
Showing 1 changed file with 36 additions and 8 deletions.
44 changes: 36 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# [C/S项目]神奇分享_**MagicShare**(中文说明)
# 神奇分享_**MagicShare**(中文说明)

[**English**](./README_EN.md)

---

Website:

[[C/S项目]神奇分享_MagicShare | ZZHow](https://www.zzhow.com/MagicShare)
[神奇分享_MagicShare(中文说明) | ZZHow](https://www.zzhow.com/MagicShare)

Source Code:

Expand All @@ -26,13 +28,13 @@ MagicShare 是一款跨平台的内网文件分享工具,发送方使用桌面

![TechnicalRoute.png](./TechnicalRoute.png)

- 编程语言:Java 和 JavaScript
- 编程语言:**Java****JavaScript**

---

## 许可证

该项目根据 GNU 通用公共许可证 v3.0 获得许可 - 有关详细信息,请参阅 [LICENSE](./LICENSE) 文件。
该项目根据 GNU 通用公共许可证 v3.0 获得许可 - 有关详细信息,请参阅 [LICENSE](https://github.com/ZZHow1024/MagicShare/blob/main/LICENSE) 文件。

---

Expand Down Expand Up @@ -70,6 +72,11 @@ https://github.com/ZZHow1024/MagicShare/releases
- 下载对应的文件。
- Linux 和 macOS 需要执行安装操作后再运行,Windows 可直接运行 .zip 压缩包中的 .exe 可执行程序或选择 .exe 安装包与 .msi 安装包执行安装操作,.jar 包可直接通过 `java -jar` 命令运行。
- 启动 MagicShare 并认真阅读启动页说明,同意 “用户许可协议” 可继续使用。
- 在 MagicShare 的主界面右下方可以选择语言。
- 当前支持中文(简体 / 繁体)与英文。
- 选择是否启用连接密码
- 若希望启用连接密码,需勾选“启用密码”并自定义 3~10 位的密码。
- 若不希望启用连接密码,需取消勾选“启用密码”。
- 自定义端口后单击 “启动服务” 按钮
- 若提示 “启动成功”,则表示服务正常启动,可将 ”分享URL“ 提供给接收方。
- 若提示 ”端口被占用“,请尝试更换端口号。
Expand All @@ -78,13 +85,16 @@ https://github.com/ZZHow1024/MagicShare/releases
- 方式一:拖拽待分享的文件/文件夹至软件主界面上半部分。
- 方式二:单击 “选择文件夹” 按钮选择待分享的文件夹。
- 方式三:在 “分享的文件/文件夹” 文本输入框中输入待分享的文件/文件夹路径,按下 “Enter” 键。
- 在软件右上方可查看当前连接数。
- 按下 “停止服务” 按钮可立即终止分享。
- 按下 “清空分享列表” 按钮可立即清空分享列表。

### Web端

- 打开浏览器,访问 ”分享URL“。
- 启动 MagicShare 并认真阅读启动页说明,同意 “用户许可协议” 可继续使用。
- 在 MagicShare 的主界面右下方可以选择语言。
- 当前支持中文(简体 / 繁体)与英文。
- 下载文件
- 单击 ”快速下载“ 使用浏览器下载器通过 HTTP 协议快速下载文件。
- 单击 ”加密下载“ 使用 MagicShare 加密下载器通过 WebSocket 协议并使用 RSA+AES 混合加密下载文件,不支持同时加密下载多个文件。
Expand All @@ -96,8 +106,8 @@ https://github.com/ZZHow1024/MagicShare/releases

该项目需要以下库:

- [**Vue.js**](https://github.com/vuejs) 及配套组件用于构建 Web 前端程序。
- [**Spring Boot**](https://github.com/spring-projects/spring-boot) 及配套组件:用于构建 Web 后端程序。
- [**Vue.js**](https://github.com/vuejs)** 及配套组件****用于构建 Web 前端程序。
- [**Spring Boot**](https://github.com/spring-projects/spring-boot)** 及配套组件:用于构建 Web 后端程序。
- [**OpenJFX**](https://openjfx.io/):用于构建图形用户界面的 JavaFX 库。

---
Expand All @@ -110,15 +120,33 @@ https://github.com/ZZHow1024/MagicShare/releases
- Web 网页下载文件。
- 支持通过 HTTP 协议快速下载文件
- 支持通过 WebSocket 协议并使用 RSA+AES 混合加密下载文件
- MagicShare2.0.0
- 当前连接数显示。
- 自定义连接密码。
- 支持多语言。
- 中文(简体/繁体)
- 英文

---

## 各版本主界面

![MagicShare1.0.0-Desktop](https://www.notion.so/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F4b165318-6383-451c-8845-110b786c9f0a%2Fcc029b9b-e911-4cd4-b9c7-4b0853fa6d04%2FMagicShare1.0.0-Desktop.png?table=block&id=17fe64bd-e40f-8066-8c2d-f5f8b1ab0a23&t=17fe64bd-e40f-8066-8c2d-f5f8b1ab0a23&width=707&cache=v2)
### MagicShare2.0.0

![MagicShare2.0.0-Desktop-ZH](https://lively-brook-dc1.notion.site/image/attachment%3A138de23b-f7c8-4c8e-8d39-7aec8d577d4d%3AMagicShare2.0.0-Desktop-ZH.png?table=block&id=24e96980-87c2-4fc8-8035-af74d7e96be0&spaceId=4b165318-6383-451c-8845-110b786c9f0a&width=1420&userId=&cache=v2)

MagicShare2.0.0-Desktop-ZH

![MagicShare2.0.0-Web-ZH](https://lively-brook-dc1.notion.site/image/attachment%3Abdaae023-be5d-4c78-970a-49e835b5f90b%3AMagicShare2.0.0-Web-ZH.png?table=block&id=c391b6ab-fc8c-4657-8f8d-bc718423e298&spaceId=4b165318-6383-451c-8845-110b786c9f0a&width=1420&userId=&cache=v2)

MagicShare2.0.0-Web-ZH

### MagicShare1.0.0

![MagicShare1.0.0-Desktop](https://lively-brook-dc1.notion.site/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F4b165318-6383-451c-8845-110b786c9f0a%2Fcc029b9b-e911-4cd4-b9c7-4b0853fa6d04%2FMagicShare1.0.0-Desktop.png?table=block&id=17fe64bd-e40f-8066-8c2d-f5f8b1ab0a23&spaceId=4b165318-6383-451c-8845-110b786c9f0a&width=1420&userId=&cache=v2)

MagicShare1.0.0-Desktop

![MagicShare1.0.0-Web](https://www.notion.so/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F4b165318-6383-451c-8845-110b786c9f0a%2Fa457bfec-f826-4936-8721-75fc46632fc2%2FMagicShare1.0.0-Web.png?table=block&id=17fe64bd-e40f-80d7-9c7c-fca929d6904d&t=17fe64bd-e40f-80d7-9c7c-fca929d6904d&width=707&cache=v2)
![MagicShare1.0.0-Web](https://lively-brook-dc1.notion.site/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F4b165318-6383-451c-8845-110b786c9f0a%2Fa457bfec-f826-4936-8721-75fc46632fc2%2FMagicShare1.0.0-Web.png?table=block&id=17fe64bd-e40f-80d7-9c7c-fca929d6904d&spaceId=4b165318-6383-451c-8845-110b786c9f0a&width=1420&userId=&cache=v2)

MagicShare1.0.0-Web

0 comments on commit 544a8f4

Please sign in to comment.