1. Introduction
I believe used github friends have contact with GitHub project READEME , it is an editing documents, mainly used in some cases introduce the project, let's learn about.
2. specification README have what
We take a look at a screenshot of a simple README regulate what's on:
The above readme specification template in our feflow the README specification can be seen in , then we work together to explore next, a complete specification README specification should have what it?
* Item Description
* How to Run
* Business
* Item Notes
Each has what effect?
project description
Note that the name of our project, the project features brief, code repository address, and the first person in charge of the project. Who passed over to our project, who is the first person in charge of the project.
How to Run
Development environment configuration : general are some of the runtime configuration we need.
Development & Published : how do we enable local development through the command, as well as build a release.
Proxy Configuration : If our project need to use some tools in the local development agency, such as fiddler or whistle , and we need to list the proxy configuration items. The best is a direct export proxy configuration file, published on the next project. If we are helpful to some of the publishing platform, the best paste release module and publish a single project, to reduce the time cost us posted.
False alarms and surveillance : I believe we will deploy the usual false alarms and monitoring logs of the project line service to help us to troubleshoot network problems now, where we can add some monitoring attributes of the project ID .
Interface API : Here we need to paste into the project got me back interface address and description, and our interface is responsible for people, when abnormal background service, you can directly contact manner .
Data reporting : We have added some of the data reported in the common project, the students give the product statistical data with business, where our best describes what data are reported below.
Business
Business entry address and channel links that is the entry page of our entire project, or more important page address. General entry page, we may be put in multiple channels, you need to list all the channels links , each page description and a detailed list of all pages within our project information, such as the following:
Page directory |
Page description |
Page links |
Parameter Description |
index |
Home |
no |
Item Notes
Project developers need to tell other key information, such as our page package build, what issues need attention, etc. This information, although not required, but can help other developers to reduce the risk of development costs.
3. the README writing rules
3-1 title
Scale representation is divided into six levels, in order to reduce the size of the displayed text. Between different levels based on the pound # number to identify the. A title has a # secondary title with two # , and so on.
E.g:
# A title
## subheadings
### three title
#### four title
##### five title
###### six title
3-2 font Emphasis
* Stressed * ( example: italics )
_ Stressed _ ( example: italics )
** emphasis added ** ( example: bold )
__ emphasis added __ ( example: bold )
*** special emphasis *** ( Example: bold italic )
___ emphasized ___ ( Example: bold italic )
3-3 Code Display
`<hello world>`
4-4 code block highlighting
` ` `
Highlight Content
` ` `
4-5 quoted text (>)
> The first line of quoted text
> The second line of quoted text
4-6 Picture reference
Picture :
! [ Picture name ] (HTTP: // ...... )
Link :
[ Link name ] (HTTPS: //www.baidu.com/)
4-7 Form
Header | header | header
---- | ----- | ------
Cell Contents | cell contents | cell contents
Cell Contents | cell contents | cell contents
4-8 List
1. Item 1
2. Item 2
3. Item 3
* Item 1 (a * number will appear as a black dot, note : there is a space, or directly displayed as * Item 1 )
* Item 2
4-9 Wrap
Note: direct the transport can not wrap !!! 1 , in the back on a line of text up two spaces, so the next line of text to wrap up. 2 , between the two lines of text in a blank line. Wrap effect can be achieved, but the line spacing a little big.
