The necessity of the README.md file

The necessity of the README.md file

Because of the preparation of the README, after a long time, you still know what you wrote in the code; because of the preparation of the README, other people do not need to look at your code so hard; because of the preparation of the README, the quality of your code is only Greatly improved; because of the preparation of README, your language level will be greatly improved.

What is included in the complete README

README files usually use Markdown language (a markup language, it is said that there are less than ten mark symbols, but it can make people elegantly immersed in recording, focusing on content instead of entangled typesetting, achieving "no dust in the heart, code words in mind" realm.)

1. Software positioning, the basic functions of the software;
2. The method of running the code: install the environment, start the command;
3. Brief instructions for use;
4. Code directory structure description, more detailed points can explain the basic principles of the software;
5. Description of common problems.

Other key information:

1. The name of the project and all submodules and libraries;
2. Description of all sub-modules and libraries;
3. How to use a library;
4. Copyright information and licensing information;
5. Command for grabbing documents;
6. Guidance on installation, configuration and operation of the program;
7. Grab the latest code and instructions for building them (or a quick overview and read Install)
8. Author list;
9. Submit a bug;
10. Other contact information; (email, website, company name, address)
11. A short historical record;
12. Legal Notices.

What can MarkDown language do?

1. Code highlighting
   

2. Make TO-do-List
   

3. Draw flowcharts, sequence diagrams, Gantt charts, tables
   
   
   
   

4. Writing mathematical formulas
   

Markdown syntax

1. Title (#)
   
2. List (-) (1.)
   
3. Quote
   
4. Bold and italic
   
5. Links and pictures
   

Links: In Markdown, insert links only need to use to display text can be.
Picture: In Markdown, you only need to use [External link picture transfer failed, the source site may have anti-theft link mechanism, it is recommended to save the picture and upload it directly (img-V3IGIOq2-1594199473635) (picture link address)].

6. Dividing line
   The grammar of the dividing line only needs to start a new line, and then enter three asterisks *** continuously to divide the content of two paragraphs of text.
7. Table
   
   
   Among them:
   :-----means left justification
   ------:right justification
   :------:center justification
8. About generating directory tree
   Use cmd, or windows powershell, cd to the directory location: enter the command tree /filename >filetree.txt to
   view the directory tree redirection to the file filetree.txt

references

If you want to load a .md file that you have written, you can select the import function in the upper toolbar to import the file with the corresponding extension, and
continue your creation.

1. Youdao Cloud Notes MarkDown Guide:
   http://note.youdao.com/iyoudao/?p=2411&vendor=unsilent14
2. Advanced Markdown Guide: http://note.youdao.com/iyoudao/?p=2445&vendor=unsilent14
3. How to write a standardized README file (windows) for development projects, this article explains in detail. https://www.cnblogs.com/wj-1314/p/8547763.html