From 0b6b7e63cf93368c5fd9ef640d307752da460032 Mon Sep 17 00:00:00 2001 From: James Sansbury Date: Tue, 24 Nov 2020 14:18:55 -0500 Subject: [PATCH] Address peer review requests --- CONTRIBUTING.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ac3a7e2..d369b700 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,23 +1,15 @@ -## Contributing to this repository +# Contributing to this repository 1. Don't edit the Dockerfiles directly. They are generated using templates. 2. Make any changes to the `*.template` files in the root of the repository. 3. Make sure you've checked the [Requirements](#requirements) below. 4. Run the `./apply-templates.sh` script after making your changes. -5. Once complete, commit all changes to the templates and Dockerfiles. +5. Once complete, (review and) commit all changes to the templates and Dockerfiles. ## Requirements -You will need [Gnu Awk](https://www.gnu.org/software/gawk/) to generate the Dockerfiles from the templates. +You will need the following software packages to run the [`./apply-templates.sh`](/apply-templates.sh) script. -To install Gnu Awk on Debian-flavors of Linux: - -``` -$ apt-get update && apt-get install gawk -``` - -To install Gnu Awk on Mac/Linux/Windows with [Homebrew](https://brew.sh/): - -``` -$ brew install gawk -``` +- [Gnu Awk](https://www.gnu.org/software/gawk/) available as `gawk`. +- [`jq`](https://stedolan.github.io/jq/) +- A recent version of Bash