readme书写

作者: 沈哲培 | 来源:发表于2018-10-15 18:18 被阅读0次

1. 小图标

![version](https://img.shields.io/badge/version-v2.0.0-brightgreen.svg?style=flat-square)
[![React](https://img.shields.io/badge/react-^16.3.1-brightgreen.svg?style=flat-square)](https://github.com/facebook/react)
 
[![MIT](https://img.shields.io/dub/l/vibe-d.svg?style=flat-square)](http://opensource.org/licenses/MIT)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)

2. MIT许可证

MIT License
Copyright (c) 2018 Youeshenzhepei@163.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

3. 语言支持

README.zh-CN.md / README.ZH.md
README.md

4. 语法

    1. 大标题 ====
    2. 中标题 -------
    3. #一级标题
       ##二级标题
       ###三级标题
       ####四级标题
       #####五级标题
       ######六级标题
    4. * 无序列表一
       * 无序列表二
       * 无序列表三
    5. 1. 有序列表一
       2. 有序列表二
       3. 有序列表三
    6. [百度](http://baidu.com)
    7. ![baidu](https://img.haomeiwen.com/i6856723/a6b3cafb43ab66f1.gif?imageMogr2/auto-orient/strip "百度logo")
    8. ```Java
       public static void main(String[] args){}
       ```
    9. [x] 已选中
    [] 未选中

5. e.g.

Installation

$ npm install egg --save

Node.js >= 8.0.0 required.

Features

✔︎ Built-in process management
✔︎ Plugin system
✔︎ Framework customization
✔︎ Lots of plugins

Docs & Community

Getting Started

Follow the commands listed below.

$ npm install egg-init -g
$ egg-init --type simple showcase && cd showcase
$ npm install
$ npm run dev
$ open http://localhost:7001

Examples

See egg-examples.

How to Contribute

Please let us know how can we help. Do check out issues for bug reports or suggestions first.
To become a contributor, please follow our contributing guide.

License

MIT

e.g.
Born to build better enterprise frameworks and apps

Installation
$npm install egg --save Node.js >= 8.0.0 required. Features ○ ✔︎ Built-in process management ○ ✔︎ Plugin system ○ ✔︎ Framework customization ○ ✔︎ Lots of plugins Docs & Community ○ Website && Documentations ○ Plugins ○ Frameworks ○ Plugin Dependency Getting Started Follow the commands listed below.$ npm install egg-init -g
$egg-init --type simple showcase && cd showcase$ npm install
$npm run dev$ open http://localhost:7001
Examples
See egg-examples.
How to Contribute
Please let us know how can we help. Do check out issues for bug reports or suggestions first.
To become a contributor, please follow our contributing guide.
License
MIT

网友评论

本文标题：readme书写

本文链接：https://www.haomeiwen.com/subject/qicqzftx.html

延伸阅读

深度阅读

您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！