From dd0747f18aada86b685ac356153e6ecab3fc4aa2 Mon Sep 17 00:00:00 2001 From: regularfry Date: Thu, 2 Nov 2023 14:09:18 +0000 Subject: [PATCH] More style fixes from vale --- README.md | 2 +- docs/developer-guides/Bash_and_Make.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3df41fa4..29f86801 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ The following software packages, or their equivalents, are expected to be instal - [GNU make](https://www.gnu.org/software/make/) 3.82 or later, - [GNU coreutils](https://www.gnu.org/software/coreutils/) and [GNU binutils](https://www.gnu.org/software/binutils/) may be required to build dependencies like Python, which may need to be compiled during installation. For macOS users, this has been scripted and automated by the `dotfiles` project; please see this [script](https://github.com/nhs-england-tools/dotfiles/blob/main/assets/20-install-base-packages.macos.sh) for details, - [Python](https://www.python.org/) required to run Git hooks, -- [jq](https://jqlang.github.io/jq/) a lightweight and flexible command-line JSON processor. +- [`jq`](https://jqlang.github.io/jq/) a lightweight and flexible command-line JSON processor. > [!NOTE]
> The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain `make` tasks will fail. On macOS, you will need [Homebrew](https://brew.sh/) installed, then to install `make`, like so: diff --git a/docs/developer-guides/Bash_and_Make.md b/docs/developer-guides/Bash_and_Make.md index 778e4529..d4379910 100644 --- a/docs/developer-guides/Bash_and_Make.md +++ b/docs/developer-guides/Bash_and_Make.md @@ -140,7 +140,7 @@ VERBOSE=1 scripts/shellscript-linter.sh ### Scripts -Most scripts provided with this repository template can utilise tools installed on your `PATH` if they are available or run them from within a Docker container. To force a script to use Docker, the `FORCE_USE_DOCKER` variable is provided. This feature increases configurability of the development environment, allowing you to use custom tooling by default if present on the command-line path. Here is an example of how to use it: +Most scripts provided with this repository template can use tools installed on your `PATH` if they are available or run them from within a Docker container. To force a script to use Docker, the `FORCE_USE_DOCKER` variable is provided. This feature allows you to use custom tooling if it is present on the command-line path. Here is how to use it: ```shell FORCE_USE_DOCKER=1 scripts/shellscript-linter.sh