diff --git a/readme.md b/readme.md index faeb6b5..fb630fc 100644 --- a/readme.md +++ b/readme.md @@ -1,31 +1,29 @@ -## 铃之椅 +[ 中文 | [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) diff --git a/readme_en.md b/readme_en.md new file mode 100644 index 0000000..fdee00a --- /dev/null +++ b/readme_en.md @@ -0,0 +1,36 @@ +[ [中文](readme.md) | English ] + +
+

LingChair

+
+ +Welcome to LingChair! This is an IM project that it provide a new communication way. And it serves people. + +> [!NOTE] + I'm sorry that I have no time to translate this project to English. This project is so large for me to rewrite, so there're still a lot of texts in Chinese. +> +> This project is still in progress, [Click me](final.md) to view progress. (Chinese) +> +> Comments and BUG report welcome + +### Usage + +Server: + + 0. Install Node.js + + 1. Clone this repo or download the source code, then run `npm install`, after that, run `npm run start` or run.bat / run.sh + +Client: + + * Use the pages that the server provide (Recommend) + + * GitHub Pages (It may cause CORS security error) + +### [Q&A (Chinese)](.github/QA.md) + +### Credits + +WIP + +### [Do you know? (Chinese)](.github/do_you_know.md)