Skip to content

Commit fcea990

Browse files
committed
Added template readme NO_JIRA
1 parent 46ae68c commit fcea990

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Script Name
2+
3+
----
4+
5+
## Summary
6+
7+
\#Description of what the script does
8+
\#Example output showing what the user can expect to see
9+
10+
## Requirements
11+
12+
\#Minimum CSD Python API version
13+
\#List of additional required CCDC modules, e.g. ccdc_rp
14+
\#List of additional non-CCDC python modules required, e.g. docxtpl
15+
\#Any additional files/resources required, e.g. additional files from this repository script folder
16+
17+
## Licensing Requirements
18+
19+
\#CCDC Licence requirements, e.g. CSD-Core, CSD-Materials, CSD-Enterprise, RP
20+
21+
## Instructions on running
22+
23+
\#Command line usage
24+
\#Arguments available
25+
\#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.)
26+
27+
## Author
28+
29+
\#Author name and date created
30+
31+
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)

0 commit comments

Comments
 (0)