update template

.github/pull_request_template.md

@@ -17,7 +17,10 @@ the repository:
 
 # Add or update a plotting script
 Here is a checklist of things that should be done to add a new plotting script to the repository:
-- [ ] The plotting script has been prepared from the template in `templates/template_plot.py`
+- [ ] The plotting script has been prepared from the template in `templates/template_plot.py` or another acceptable plotting script
+- [ ] The plot follows the Good Plot Guide in [`tomplot/good_plot_guide.md`](https://github.com/tommbendall/tomplot/blob/main/good_plot_guide.md)
+- [ ] Relevant initial and final fields are plotted
+- [ ] The figures produced have been added to the repository
 
 <!--
 Here is a comment that can include verbose instructions that will not

README.md

@@ -1 +1,18 @@
-A repository for holding scripts setting up working case studies for Gusto.
+# Gusto Case Studies
+
+Welcome to the Gusto Case Studies repository!
+
+This stores a collection of Python scripts which implement standard (and more exotic) test cases for geophysical fluids, particularly those used in the development of the dynamical cores used in numerical weather prediction models.
+
+The test cases are run using the [Gusto](https://www.firedrakeproject.org/gusto/) code library, which uses compatible finite element methods to discretise the fluid's equations of motion.
+Gusto is built upon the [Firedrake](https://www.firedrakeproject.org/) software, which provides the finite element infrastructure used by Gusto.
+
+Case studies are organised by governing equation. Each case study is accompanied by a plotting script, and reference figures.
+
+Our continuous integration is intended to ensure that this repository runs at the Gusto head-of-trunk.
+
+## Visualisation
+
+Gusto can produce output in two formats:
+- VTU files, which can be viewed with the [Paraview](https://www.paraview.org/) software
+- netCDF files, which has data that can be plotted using standard python packages such as matplotlib. We suggest using the [tomplot](https://github.com/tommbendall/tomplot) python library, which contains several routines to simplify the plotting of Gusto output.