diff --git a/README.md b/README.md index 6302533..02fc693 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,182 @@ # EmoLLM +ProjectName and Description -## 🌟 Contributors + -[![EmoLLM contributors](https://contrib.rocks/image?repo=aJupyter/EmoLLM&max=200)](https://github.com/aJupyter/EmoLLM/graphs/contributors) +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] +[![LinkedIn][linkedin-shield]][linkedin-url] + + +
+ +

+ + Logo + + +

EmoLLM

+

+
+ 探索本项目的文档 » +
+
+ 查看Demo + · + 报告Bug + · + 提出新特性 +

+ +

+ 本篇README.md面向开发者 + +## 目录 + +- [上手指南](#上手指南) + - [开发前的配置要求](#开发前的配置要求) + - [安装步骤](#安装步骤) +- [文件目录说明](#文件目录说明) +- [开发的架构](#开发的架构) +- [部署](#部署) +- [使用到的框架](#使用到的框架) +- [贡献者](#贡献者) + - [如何参与开源项目](#如何参与开源项目) +- [版本控制](#版本控制) +- [作者](#作者) +- [鸣谢](#鸣谢) + +### 上手指南 + +请将所有链接中的“shaojintian/Best_README_template”改为“your_github_name/your_repository” + + + +###### 开发前的配置要求 + +1. xxxxx x.x.x +2. xxxxx x.x.x + +###### **安装步骤** + +1. Get a free API Key at [https://example.com](https://example.com) +2. Clone the repo + +```sh +git clone https://github.com/shaojintian/Best_README_template.git +``` + +### 文件目录说明 +eg: + +``` +filetree +├── ARCHITECTURE.md +├── LICENSE.txt +├── README.md +├── /account/ +├── /bbs/ +├── /docs/ +│ ├── /rules/ +│ │ ├── backend.txt +│ │ └── frontend.txt +├── manage.py +├── /oa/ +├── /static/ +├── /templates/ +├── useless.md +└── /util/ + +``` + + + + + +### 开发的架构 + +请阅读[ARCHITECTURE.md](https://github.com/aJupyter/EmoLLM/blob/master/ARCHITECTURE.md) 查阅为该项目的架构。 + +### 部署 + +暂无 + +### 使用到的框架 + +- [xxxxxxx](https://getbootstrap.com) +- [xxxxxxx](https://jquery.com) +- [xxxxxxx](https://laravel.com) + +### 贡献者 + +请阅读**CONTRIBUTING.md** 查阅为该项目做出贡献的开发者。 + +#### 如何参与开源项目 + +贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是**非常感谢**的。 + + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + + + +### 版本控制 + +该项目使用Git进行版本管理。您可以在repository参看当前可用版本。 + +### 作者 + +xxx@xxxx + +知乎:xxxx   qq:xxxxxx + + *您也可以在贡献者名单中参看所有参与该项目的开发者。* + +### 版权说明 + +该项目签署了MIT 授权许可,详情请参阅 [LICENSE.txt](https://github.com/aJupyter/EmoLLM/blob/master/LICENSE.txt) + +### 鸣谢 + + +- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) +- [Img Shields](https://shields.io) +- [Choose an Open Source License](https://choosealicense.com) +- [GitHub Pages](https://pages.github.com) +- [Animate.css](https://daneden.github.io/animate.css) +- [xxxxxxxxxxxxxx](https://connoratherton.com/loaders) + + +[your-project-path]:aJupyter/EmoLLM +[contributors-shield]: https://img.shields.io/github/contributors/aJupyter/EmoLLM.svg?style=flat-square +[contributors-url]: https://github.com/aJupyter/EmoLLM/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/aJupyter/EmoLLM.svg?style=flat-square +[forks-url]: https://github.com/aJupyter/EmoLLM/network/members +[stars-shield]: https://img.shields.io/github/stars/aJupyter/EmoLLM.svg?style=flat-square +[stars-url]: https://github.com/aJupyter/EmoLLM/stargazers +[issues-shield]: https://img.shields.io/github/issues/aJupyter/EmoLLM.svg?style=flat-square +[issues-url]: https://img.shields.io/github/issues/aJupyter/EmoLLM.svg +[license-shield]: https://img.shields.io/github/license/aJupyter/EmoLLM.svg?style=flat-square +[license-url]: https://github.com/aJupyter/EmoLLM/blob/master/LICENSE.txt +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/aJupyter + + + + + + + + +## Star History +[![Star History Chart](https://api.star-history.com/svg?repos=aJupyter/EmoLLM&type=Date)](https://star-history.com/#aJupyter/EmoLLM&Date)