ContentGrabbingJi/README.md
LamGC 4c384cc991
[Add][Update][Document] Framework-API, Project 更新Readme文档内容;
[Update] Project/README.md 更新一些贡献内容, 修正文档问题;
[Update] Framework-API/Readme.md 补充框架生命周期内容;
[Add] Framework-API/Quick-Start.md 添加尚未完成的快速开始教程文档, 计划在 3.0.0 正式版发布时完成;
2020-12-19 14:08:27 +08:00

48 lines
2.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# ContentGrabbingJi
一个以高性能、高效率为目标、多框架/平台支持、持续维护的Pixiv聊天机器人。
(重构进行中,欢迎围观 or 贡献!)
(旧版还能用,只是不再继续维护)
<!-- 此处为 Tag 栏, 可以不加空格(大概) -->
![Unit test confirmation of commit](https://github.com/LamGC/ContentGrabbingJi/workflows/Unit%20test%20confirmation%20of%20commit/badge.svg?branch=3.0.0&event=push)
[![codecov](https://codecov.io/gh/LamGC/ContentGrabbingJi/branch/3.0.0/graph/badge.svg)](https://codecov.io/gh/LamGC/ContentGrabbingJi)
## Install ##
待 3.0.0-alpha 版发布后将会更新!
## Usage ##
## Contributing ##
> 本项目遵循[语义化版本控制 SemVer](https://semver.org/) 规范,
>不同版本号之间的兼容性将依照 SemVer 规范得到保证(不会出现 1.0.1 版本不兼容 1.0.0 版本,或 1.2.0 版本不支持 1.1.0 版本的情况)。
欢迎你为 ContentGrabbingJi 项目作出贡献!
在开始作出贡献前,请阅读 [贡献者公约 Code of conduct](./CODE_OF_CONDUCT.md)
一旦你开始为本项目作出贡献(无论通过何种形式),将会视你为同意遵守贡献者公约,并接受因违反贡献者公约而带来的后果。
如果你准备好开始为本项目做出贡献(或正在做出贡献)时,请阅读并遵守[贡献准则](.github/CONTRIBUTING.md)。
## License ##
ContentGrabbingJi 是遵循 GNU Affero General Public License v3.0 协议(下称 AGPLv3开源的
完全免费的项目(软件),任何人(或组织)不允许违反 AGPLv3 开源协议来使用本项目。
> 使用者通过使用本项目为用户提供服务时,请注意遵守服务使用者所在地的法律法规,因违规使用本项目而带来的后果由使用者自行负责。
```
Copyright (C) 2020 LamGC
ContentGrabbingJi is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
ContentGrabbingJi is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FLamGC%2FContentGrabbingJi.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FLamGC%2FContentGrabbingJi?ref=badge_large)