From f1fffd9066306cb2d038c957025f6c1caf2cf6ac Mon Sep 17 00:00:00 2001 From: Frantjc Date: Wed, 4 Dec 2024 14:26:13 -0500 Subject: [PATCH] docs --- docs/developing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/developing.md b/docs/developing.md index 566fe0d5..13e5f05c 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -1,15 +1,15 @@ # Developing Forge -First, ensure you've installed the prerequisites: +First, ensure you've installed the necessary prerequisites: - `git` is _required_. - `go` >=1.20 is _required_ for multi-error handling. - `docker` is _required_ to test as it is its only runtime. -- `make` is _required_. +- `make` is _recommended_. - [`upx`](https://github.com/upx/upx) is _required_ for compressing [`shim`](https://github.com/frantjc/forge/blob/main/internal/cmd/shim/main.go). - `node` >=20 is _required_ for developing the [action](https://github.com/frantjc/forge/blob/main/.github/actions/setup-forge). -Next, get an understanding for how Forge works. `forge` command works roughly the same way: +Next, get an understanding for how `forge` works. Each `forge` command follows roughly the same pattern: ![Diagram](diag.png)