Skip to content

Commit c84ba5a

Browse files
committed
Corrected formatting of readme template NO_JIRA
1 parent fcea990 commit c84ba5a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

scripts/new_script_readme_template/ReadMe.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@
55
## Summary
66

77
\#Description of what the script does
8+
89
\#Example output showing what the user can expect to see
910

1011
## Requirements
1112

1213
\#Minimum CSD Python API version
14+
1315
\#List of additional required CCDC modules, e.g. ccdc_rp
16+
1417
\#List of additional non-CCDC python modules required, e.g. docxtpl
18+
1519
\#Any additional files/resources required, e.g. additional files from this repository script folder
1620

1721
## Licensing Requirements
@@ -21,7 +25,9 @@
2125
## Instructions on running
2226

2327
\#Command line usage
28+
2429
\#Arguments available
30+
2531
\#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.)
2632

2733
## Author

0 commit comments

Comments
 (0)