Amended ReadMe Files NO_JIRA

Author: Alex-AMC

README.md

@@ -10,7 +10,7 @@ the [CSD-Python API ](https://www.ccdc.cam.ac.uk/solutions/csd-core/components/c
 
 The purpose of this platform is to distribute knowledge and allow for scientific collaborations. Scripts are provided on an as-is basis and while their use is not supported we do welcome feedback on potential improvements. All scripts are tested against the latest version of the CSD Python API as installed with the CSD Portfolio.
 
-> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk.](support@ccdc.cam.ac.uk.)
+> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)
 
 ## Content 
 
@@ -26,6 +26,8 @@ The purpose of this platform is to distribute knowledge and allow for scientific
 
 Valid CSD Portfolio licence is required for all scripts, some will require additional licence levels for use, such as Discovery and Materials. Requirements are clearly displayed in the `ReadMe` that accompanies each script. 
 
+Don’t have a licence? Contact us [here to request a quote or demonstration.](https://www.ccdc.cam.ac.uk/theccdcprofile/contactus/)
+
 ## Downloading Scripts
 
 This section will focus on how to download multiple or individual scripts: 
@@ -42,8 +44,8 @@ This section will focus on how to download multiple or individual scripts:
 #### TO DO - write instructions on how to download
 
 
-## Running scripts through the CSD-Python API Miniconda installed 
+## Running scripts through the CSD Python API Miniconda installed 
 
-This requires you to already have the CSD-Python API installed. 
+This requires you to already have the CSD Python API installed. 
 
 ##### TODO - Write instructions 

scripts/ReadMe.md

@@ -1,14 +1,17 @@
 ## Contents
 
+This folder contains scripts submitted by users or CCDC scientists for anyone to use freely. 
+
 ### Hydrogen bond propensity : 
-    - Details ... 
+- Writes a .docx report of a hydrogen bond propensity calculation for any given mol2/refcode.
 
 ### Multi-component hydrogen bond propensity: 
-    - Details ...
+- Performs a multi-component HBP calculation for a given library of co-formers. 
 
 ### Packing similarity dendrogram:
-    - Details ...
+-  Construct a dendrogram for an input set of structures based on packing-similarity
+analysis
 
 
 ## Tips 
-    - Searching tips: 
+### Searching tips: 

scripts/hydrogen_bond_propensity/ReadMe.md

@@ -1,21 +1,37 @@
 # Hydrogen Bond Propensity 
 
-----
+Writes a .docx report of a hydrogen bond propensity calculation
 
+----
 [Summary]
 
 ## Example 
 
 \#TODO [Output from script]
 
 ## Requirements 
-\#TODO [List] 
 
+```matplotlib, docxtpl```
+
+- hydrogen_bond_propensity_report.docx
 ## Licensing Requirements 
 \#TODO [LIST]
 
 ## Instructions on running
-\#TODO [Example run]
+
+Using mol2 file 
+```cmd
+activate ccdc
+python hydrogen_bond_propensity_report.py structure.mol2 
+```
+
+Options: 
+
+- \- d | --directory - sets the working directory 
+- \- n | --noopen - Do not automatically open the generated output file.
 
 ## Author
-\#TODO [Add] 
+
+_Andrew Maloney_ - CCDC (2017)
+
+> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)

scripts/multi_component_hydrogen_bond_propensity/ReadMe.md

@@ -18,4 +18,6 @@
 \#TODO [Example run]
 
 ## Author
-\#TODO [Add] 
+\#TODO [Add] 
+
+> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)

scripts/packing_similarity_dendrogram/ReadMe.md

@@ -163,3 +163,5 @@ retained by default in the packing-similarity analysis.
 
 ## Authors: 
 _Anthony Reilly(2016)_
+
+> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](support@ccdc.cam.ac.uk)