Looking at GitHub's open source project, we can all see the figure.md file.

Many classmates like to upload their own projects to Git to host, but they can always find a problem:Obviously this project is quite marketable, why this code is put on, it seems very "unofficial"!

Generally, the author will start with the file structure, code style, etc. to solve the image of this project.

A valuable project must not only reflect this value in terms of function, but also reflect this value from the style of the text. One says that the code style bought by a few dollars and the code style of several hundred dollars and thousands of dollars is really large.Looking at the image of the document, consumers feel that the money is worth it.

For strangers, Readme is the window of the project program. The reader will take about 30 seconds to capture the main points of the project content. therefore,Readme should be an overview of the project as a wholeEssence In fact, this static file has an agreed norm, which is formed by many open source developers.

1. Project Introduction

2. What function does the code implement?

3. How to use? (System environmental parameters, deployment elements, operation instructions, etc.)

4. What is the code tissue architecture? (Directory structure description, etc.)

5. Edition update important summary (this is very important)

If your readme includes the above content, then when the user gets the code and opens the readme, you basically know how to start.

Usually you use Markdown syntax to write the readme file (ie Readme.md), and of course there are txts (ie Readme.txt). The author is more preferred to Markdown syntax, mainly because it can make simple typesetting.

Here is an example of the readme.md of my own project as an example:

# Project Introduction 
         This project is established for the DDS service file generated by the code tool chain.

         It can merge multiple DDS service files to build a Basic server -side server and client program framework. Including generating server.cpp, client.cpp, cmakelists.txt

 # Environmental dependence


 # Directory structure description
         M ── Readme.md // Help documentation
    
         C ── AutoCreateds.py // Python script file that synthesizes DDS
    
         O ── DDSCORE // DDS core file library, which contains various versions of Include, SRC, LIB folders, which are convenient to merge
    
         │ n ─ ─ n include_src // contains each version of the Include and SRC folders
    
    │       ├── V1.0
    
    │           ├── include
    
    │           └── src
    
    │       └── V......
    
         │ i── b / / folder
    
         │ r── ARM64 // Support the lib folder of the ARM64 system version
    
    │           ├── V1.0
    
    │           └── V......
    
         │ x ──X86 // LIB folder supports the X86 system version
    
    │           ├── V1.0
    
    │           └── V......
    
         T ──Target // Folders stored in the synthetic result
    
         / ──TMP // The service folder of the service to be merged

 # Instructions for use 



 # Version content update
###### v1.0.0: 
         1. Implement the copy and merge of the Gen file
    
         2. Implement the merging of the Common file
    
         3. Realize the copy of the specified version of the Include, SRC, LIB files

The effect of implementation is as follows:

This style is a relatively simple style. When developers are skilled, they will gradually form their own code style.

The text specification is very important for a programmer. It can be said to be a programmer's image, saying that "the word is like it" is not too much. In the team, if you are familiar with each other, you can basically know which members of these texts or codes can be through the clues between these words.