You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: scripts/new_script_readme_template/ReadMe.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,17 @@
5
5
## Summary
6
6
7
7
\#Description of what the script does
8
+
8
9
\#Example output showing what the user can expect to see
9
10
10
11
## Requirements
11
12
12
13
\#Minimum CSD Python API version
14
+
13
15
\#List of additional required CCDC modules, e.g. ccdc_rp
16
+
14
17
\#List of additional non-CCDC python modules required, e.g. docxtpl
18
+
15
19
\#Any additional files/resources required, e.g. additional files from this repository script folder
16
20
17
21
## Licensing Requirements
@@ -21,7 +25,9 @@
21
25
## Instructions on running
22
26
23
27
\#Command line usage
28
+
24
29
\#Arguments available
30
+
25
31
\#Additional resources required, e.g. file from the script repository and how that is used (e.g. in same folder as python script, used in an argument etc.)
0 commit comments