docs: readme

This commit is contained in:
满月叶
2024-06-15 10:05:07 +08:00
committed by GitHub
parent 1cb0dd3885
commit 733d5f76c3

View File

@@ -2,30 +2,26 @@
欢迎来到铃之椅! 这是一个即时通讯项目, 为通讯提供更多的选择, 为人民服务
[ 中文 | [English](readme_en.md) ]
> [!NOTE]
> 本项目仍在实验阶段, [点我](final.md)可查看进展
>
> 如果有任何问题,欢迎你提出来,我会不定时查看
>
> 另外 Android 客户端也在开发, 但进展缓慢
> 欢迎各位提出项目修改意见
### 使用
服务端:
0. 确保安装 Node.js
0. 安装 Node.js
1. 克隆本仓库源代码到本地,并运行 run_build.sh 构建网页
1. 克隆或下载本仓库源代码,执行`npm install`,再执行`npm run start` 或者运行 run.bat / run.sh
2. 运行 run.sh
客户端:
网页端:
* 直接使用和服务端集成的网页 (推荐)
* 克隆本仓库到本地并运行本地 HTTP 服务端
* 使用服务端提供的网页 (推荐)
* 静态网页 (不推荐)
* GitHub Pages (可能导致跨域问题)
### [Q&A](.github/QA.md)