Skip to content

shaojintian/Best_README_template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 

Repository files navigation

ProjectName

ProjectName and Description

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

"完美的"README模板

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

查看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
  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 查阅为该项目的架构。

部署

暂无

使用到的框架

贡献者

请阅读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

鸣谢