Skip to content

get-started-tutorials/how-to-write-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 

Repository files navigation

how-to-write-readme

What all should good document contain ->

Things like

  1. Description
  2. Installation/Examples
       Prerequistes
       actualsteps
    challenges
  3. Supported versions
  4. Known Issues/Limitation
  5. Contribution
  6. Licenses

Third party libraries/tools with good docs with example on how to do => users tend to consume and contribute to this.

If not available, we may not use the library or switch to library with good doc or write our document for library with no document.

Do not assume the end user would know it.

choosealicense.com => to pick license

function test() {
 console.log("look ma’, no spaces");
}
function test() {
 console.log("look ma’, no spaces");
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published