Skip to content

Commit 9d216b8

Browse files
Update readme_template.md
1 parent 8cced93 commit 9d216b8

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.github/readme_template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,50 @@
11
# Package/Script Name
22

3+
## Aim
4+
5+
The main aim of the project you want to achieve.
6+
7+
## Purpose
8+
9+
What's the purpose of this project
10+
311
## Short description of package/script
412

513
- If package, list of functionalities/scripts it can perform
614
- If standalone script, short description of script explaining what it achieves.
715
- List out the libraries imported.
816

17+
18+
## Workflow of the Project
19+
20+
Add the workflow of the project point by point to get good understanding of the program
21+
22+
923
## Setup instructions
1024

1125
Explain how to setup and run your package/script in user's system
1226

27+
1328
## Detailed explanation of script, if needed
1429

1530
If code is not explainable using comments, use this sections to explain your script
1631

32+
33+
## Compilation Steps
34+
35+
Briefly show the compilation steps of the project
36+
37+
1738
## Output
1839

1940
Display images/gifs/videos of output/result of your script so that users can visualize it
2041

42+
2143
## Author(s)
2244

2345
Name(s) of author(s)
2446

47+
2548
## Disclaimers, if any
2649

2750
Use this section to mention if any particular disclaimer is required

0 commit comments

Comments
 (0)