Pub_doc/git相关/项目说明模板
xu 6f5b65bf52 【类 型】:docs
【主	题】:根据公司情况修改模板
【描	述】:
	[原因]:
	[过程]:
	[影响]:
【结	束】

# 类型 包含:
# feat:新功能(feature)
# fix:修补bug
# docs:文档(documentation)
# style: 格式(不影响代码运行的变动)
# refactor:重构(即不是新增功能,也不是修改bug的代码变动)
# test:增加测试
# chore:构建过程或辅助工具的变动
2024-05-30 19:12:13 +08:00
..
images 【类 型】:docs 2024-05-30 18:59:21 +08:00
LICENSE.txt 【类 型】:docs 2024-05-30 18:59:21 +08:00
README.md 【类 型】:docs 2024-05-30 19:12:13 +08:00

ProjectName

ProjectName and Description

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url]


Logo

飞行魔方README模板

一个README模板去快速开始你的项目
探索本项目的文档 »

查看Demo · 报告Bug · 提出新特性

本篇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
  2. Clone the repo
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 查阅为该项目的架构。

部署

暂无

使用到的框架