Skip to content

Latest commit

 

History

History
13 lines (10 loc) · 526 Bytes

README_GUIDELINES.md

File metadata and controls

13 lines (10 loc) · 526 Bytes

Readme guidelines


The following should be kept in mind while creating a README.md file

  • Every project should have it
  • It should be beautified with markdown language
  • It should contain instrunctions on how to run the project.
  • It can also contain projenct demo links, gifs, or pngs.
  • It should contain build instructions in case the project binaries are not uploaded.
  • It should contain use cases of the project and its relevance.

Sample README