Merge branch 'main' of https://github.com/nesi/nesi-wordlist

README.md

@@ -1,8 +1,12 @@
 A wordlist for use across various projects.
 
-## How to use.
+The yaml files in `dic/` inform several different things (at present). 
+Editing any of these files should trigger regeneration of the outputs.
 
-The yaml files in `dic/` inform several different things (at present). Editing any of these files should trigger regeneration of the outputs.
+## Adding Words
+
+Choose a category file from `dic/` (or add a new one if required).
+The yaml files are dictionaries, where the key is the word in question, and the parameters are as below.
 
 ### Parameters
 
@@ -17,6 +21,10 @@ The yaml files in `dic/` inform several different things (at present). Editing a
 
 Defaults currently hardcoded in [`generate.py`](./generate.py)
 
+### Automatically Generated inputs.
+
+`software_names.yaml` is generated by running `generate_software_names_dic.py`
+
 ### Aliases
 
 Word aliases can be created with standard YAML syntax.
@@ -25,6 +33,7 @@ Word aliases can be created with standard YAML syntax.
 * The alias word must equal the tag `*value`.
 
 ### Example
+
 Example entry and alias.
 ```
 - HPC: &hpc
@@ -81,6 +90,7 @@ smthe
 #### Currently used in
 * [zendesk-macros](https://git.hpcf.nesi.org.nz/nesi-apps/zendesk-macros)
 * [mkdocs](https://git.hpcf.nesi.org.nz/nesi-apps/mkdocs)
+* [support docs](https://github.com/nesi/support-docs-concept)
 * [migratedocs](https://git.hpcf.nesi.org.nz/cwal219/migratedocs)
 
 ### `Glossary.md`