readme.md

This commit is contained in:
Mechanel 2023-08-30 10:32:45 +08:00
parent fa458f6d54
commit fd856731ae

View File

@ -1,4 +1,4 @@
# FreeKill
# 新月杀(FreeKill
![](https://img.shields.io/github/repo-size/notify-ctrl/freekill?color=green)
![](https://img.shields.io/github/languages/top/Notify-ctrl/FreeKill)
@ -12,15 +12,15 @@ ___
## 关于本项目
FreeKill是一款开源的三国杀游戏但其目的不在于补完官方所有武将而是着力于提供一个最适合DIY的框架。
新月杀(FreeKill是一款开源的三国杀游戏但其目的不在于补完官方所有武将而是着力于提供一个最适合DIY的框架。
## 项目文档
[FreeKill文档](https://qsgs-fans.github.io/FreeKill/usr/index.html)
[新月杀文档](https://qsgs-fans.github.io/FreeKill/usr/index.html)
### 依赖的库
以下是FreeKill运行所必不可少的依赖库:
以下是新月杀运行所必不可少的依赖库:
* [![](https://img.shields.io/badge/qt6-50D160?style=for-the-badge&logo=qt&logoColor=white)](https://www.qt.io)
* [![](https://img.shields.io/badge/lua5.4-030380?style=for-the-badge&logo=lua)](https://www.lua.org)
@ -28,7 +28,7 @@ FreeKill是一款开源的三国杀游戏但其目的不在于补完官方所
* [![](https://img.shields.io/badge/libgit2-FFFFFF?style=for-the-badge&logo=git)](https://www.libgit2.org)
* [![](https://img.shields.io/badge/openssl-721412?style=for-the-badge&logo=openssl)](https://www.openssl.org)
FreeKill在编译过程中需要用到cmake, flex, bison, swig。
新月杀在编译过程中需要用到cmake, flex, bison, swig。
___
@ -46,13 +46,13 @@ ___
## 如何构建
关于如何从头构建FreeKill,详见[编译教程](https://qsgs-fans.github.io/FreeKill/inner/01-compile.html)。
关于如何从头构建新月杀,详见[编译教程](https://qsgs-fans.github.io/FreeKill/inner/01-compile.html)。
___
## 参与其中
若您能为FreeKill做出贡献,我们将不胜感激。
若您能为新月杀做出贡献,我们将不胜感激。
如若您能提出良好的建议请fork本仓库然后提交PR。您也可以单纯只提出一个issue或者为repo点一个star。再次感谢您的帮助。