Create README.md

This commit is contained in:
Frederick Chen
2026-01-23 23:23:35 +08:00
committed by GitHub
parent 92a8be055b
commit 21ade05bc7

26
README.md Normal file
View File

@@ -0,0 +1,26 @@
# letsplay-server-community-guide
## 部署
采用 [material-for-mkdocs](https://squidfunk.github.io/mkdocs-material/) 部署于 [lpsguide.cn](https://lpsguide.cn)。
当然,你可以本地进行部署。
```bash
# 克隆仓库
git clone https://github.com/mtrlps-community/lps-community-guide.git
# 安装 material-for-mkdocs 及插件
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin
# 转至仓库
cd lps-community-guide
# 运行服务器
mkdocs serve
```
## 贡献
我们非常欢迎你为 **lps-community-guide** 编写内容,让更多玩家受益。
这里也非常感谢参与本项目的[朋友们](https://github.com/mtrlps-community/lps-community-guide/graphs/contributors)和为本项目捐赠的[朋友们](https://www.lpsguide.cn/about/sponsorship/)。
> **lps-community-guide** © mtrlps-community | 除特别注明外,项目中除了代码部分均采用 [(Creative Commons BY-SA 4.0) 知识共享署名 - 相同方式共享 4.0 国际许可协议](LICENSE) 协议,使用过程中您可以自由地共享、演绎,但是必须署名、以相同方式共享、分享时没有附加限制。