[Project Setup]: Readme

[turn-a-round]

[ChinmoyJana14]

@turn-a-round , eta te scope ta ki? Mane amay ki Korte hobe, suru korini, ei weekend e bosbo

[turn-a-round]

Full documentaion (include Readme, Changelog, Wiki etc.)

[ChinmoyJana14]

Include A README file that contains
A brief description of the project
Installation instructions
A short example/tutorial
Allow issue tracker for others
Write an API documentation
What a function do
What the function's parameters or arguments are
What a function returns
An example for code documentation.
An example for code documentation.
Document your code
Apply coding conventions, such as file organization, comments, naming conventions, programming practices, etc.
Include information for contributors
Include citation information
Include licensing information
Link to your e-mail address at the end
List all the version of the files along with the major edits you did in each version