xu
5941f91402
详细描述 # 类型 包含: # feat：新功能（feature） # fix：修补bug # docs：文档（documentation） # style： 格式（不影响代码运行的变动） # refactor：重构（即不是新增功能，也不是修改bug的代码变动） # test：增加测试 # chore：构建过程或辅助工具的变动
106 lines
1.6 KiB
Markdown
106 lines
1.6 KiB
Markdown
|
|
|
|
# 项目名称
|
|
|
|
项目简单描述
|
|
|
|
|
|
本篇README.md面向飞行魔方授权开发者
|
|
|
|
## 目录
|
|
|
|
- [项目描述](#项目描述)
|
|
|
|
- [上手指南](#上手指南)
|
|
|
|
- [开发前的配置要求](#开发前的配置要求)
|
|
- [安装步骤](#安装步骤)
|
|
|
|
- [文件目录说明](#文件目录说明)
|
|
|
|
- [开发的架构](#开发的架构)
|
|
|
|
- [部署](#部署)
|
|
|
|
- [使用到的框架](#使用到的框架)
|
|
|
|
|
|
|
|
### 项目描述
|
|
|
|
###### 主要功能：
|
|
|
|
1. xxxxx x.x.x
|
|
2. xxxxx x.x.x
|
|
|
|
###### 物理连接：
|
|
|
|
1. xxxxx x.x.x
|
|
2. xxxxx x.x.x
|
|
|
|
|
|
|
|
### 上手指南
|
|
|
|
请将所有链接中的“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/shaojintian/Best_README_template/blob/master/ARCHITECTURE.md) 查阅为该项目的架构。
|
|
|
|
### 部署
|
|
|
|
暂无
|
|
|
|
### 使用到的框架
|
|
|
|
- [xxxxxxx](https://getbootstrap.com)
|
|
- [xxxxxxx](https://jquery.com)
|
|
- [xxxxxxx](https://laravel.com)
|
|
|
|
|
|
|