File tree Expand file tree Collapse file tree 1 file changed +23
-0
lines changed Expand file tree Collapse file tree 1 file changed +23
-0
lines changed Original file line number Diff line number Diff line change 1
1
# Package/Script Name
2
2
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
+
3
11
## Short description of package/script
4
12
5
13
- If package, list of functionalities/scripts it can perform
6
14
- If standalone script, short description of script explaining what it achieves.
7
15
- List out the libraries imported.
8
16
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
+
9
23
## Setup instructions
10
24
11
25
Explain how to setup and run your package/script in user's system
12
26
27
+
13
28
## Detailed explanation of script, if needed
14
29
15
30
If code is not explainable using comments, use this sections to explain your script
16
31
32
+
33
+ ## Compilation Steps
34
+
35
+ Briefly show the compilation steps of the project
36
+
37
+
17
38
## Output
18
39
19
40
Display images/gifs/videos of output/result of your script so that users can visualize it
20
41
42
+
21
43
## Author(s)
22
44
23
45
Name(s) of author(s)
24
46
47
+
25
48
## Disclaimers, if any
26
49
27
50
Use this section to mention if any particular disclaimer is required
You can’t perform that action at this time.
0 commit comments