From f2cbb2b4e3f42500c5dcfde248f84a1d2dcf174b Mon Sep 17 00:00:00 2001
From: Micael Oliveira <micael.oliveira@anu.edu.au>
Date: Wed, 17 May 2023 16:21:57 +1000
Subject: [PATCH 1/2] Add instructions to build and install the tools.

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/README.md b/README.md
index e82e5eb..25b04f6 100644
--- a/README.md
+++ b/README.md
@@ -124,3 +124,49 @@ double-precision topography file.
 
 Options
   * `--vgrid <vgrid>`  vertical grid (default 'ocean_vgrid.nc')
+
+
+# Building and Installation
+
+## General Instructions
+
+### Prerequisites
+
+To compile these tools one needs:
+- Fortran compiler
+- netCDF-Fortran
+- CMake
+
+### Step-by-step instructions
+
+`domain-tools` uses CMake for building and installation. Therefore the procedure
+to build the sources and install the executables is fairly standard:
+```console
+git clone https://github.com/COSIMA/domain-tools.git
+cd domain-tools
+cmake -B build -DCMAKE_BUILD_TYPE=Release
+cmake --build build
+cmake --install build --prefix=<directory where to install the tools>
+```
+
+## Gadi
+
+An installation of these tools is available on Gadi. To use it, you need to be a
+member of group `ik11` and load the corresponding module:
+
+```console
+module use /g/data/ik11/spack/modules
+module load domain-tools
+```
+
+If instead you wish to build and install the tools from the sources, you can
+follow a slighly modified version of above step-be-step instructions:
+```console
+module load intel-compiler netcdf
+export NetCDF_ROOT=$(nc-config --prefix)
+git clone https://github.com/COSIMA/domain-tools.git
+cd domain-tools
+cmake -B build -DCMAKE_BUILD_TYPE=Release -DNetCDF_Fortran_LIBRARY=$NetCDF_ROOT/lib/Intel/libnetcdff.so -DNetCDF_C_LIBRARY=$NetCDF_ROOT/lib/libnetcdf.so -DNetCDF_Fortran_INCLUDE_DIRS=$NetCDF_ROOT/include/Intel
+cmake --build build
+cmake --install build --prefix=<directory where to install the tools>
+```

From 2f5d59b339b0efd74f5947ef8ca4efb3d39b07b5 Mon Sep 17 00:00:00 2001
From: Micael Oliveira <micael.oliveira@anu.edu.au>
Date: Thu, 18 May 2023 09:30:06 +1000
Subject: [PATCH 2/2] Add CI badge.

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 25b04f6..8a06a21 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+[![compilation](https://github.com/COSIMA/domain-tools/actions/workflows/compilation.yml/badge.svg)](https://github.com/COSIMA/domain-tools/actions/workflows/compilation.yml)
+
 # Domain Tools
 
 Code and tools to edit and manipulate ocean model grids and topographies.