Commit 854593a

authored

Create Template for README.md

1 parent ebb07bb commit 854593aCopy full SHA for 854593a

File tree

+26

-0

lines changed

+26

-0

lines changed

Lines changed: 26 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,26 @@`
	`1`	`+# Package/Script Name`
	`2`	`+`
	`3`	`+Short description of package/script`
	`4`	`+`
	`5`	`+- If package, list of functionalities/scripts it can perform`
	`6`	`+- If standalone script, short description of script explaining what it achieves`
	`7`	`+`
	`8`	`+## Setup instructions`
	`9`	`+`
	`10`	`+Explain how to setup and run your package/script in user's system`
	`11`	`+`
	`12`	`+## Detailed explanation of script, if needed`
	`13`	`+`
	`14`	`+If code is not explainable using comments, use this sections to explain your script`
	`15`	`+`
	`16`	`+## Output`
	`17`	`+`
	`18`	`+Display images/gifs/videos of output/result of your script so that users can visualize it`
	`19`	`+`
	`20`	`+## Author(s)`
	`21`	`+`
	`22`	`+Name(s) of author(s)`
	`23`	`+`
	`24`	`+## Disclaimers, if any`
	`25`	`+`
	`26`	`+Use this section to mention if any particular disclaimer is required`

Comments

(0)