Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 1.01 KB

readme Essentials.md

File metadata and controls

33 lines (29 loc) · 1.01 KB

| Writing a good README - newbies manual |

Open a README.md. file in a new project.

*****************************************************
********************************************************
Make sure the file always includes the following elements:
************************************************************
***************************************************************
  1. Titles and internal titles
  2. Introduction - the project's aim
  3. Technologies
  4. Launch
************************************************************
***                                                      ***
***  Consider also using additional elements such as:    ***
***                                                      ***
*************************************************************
  • Table of contents
  • Illustrations
  • Scope of functionalities
  • Examples of use
  • Project status
  • Sources
  • Other information