Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
frantjc committed Dec 4, 2024
1 parent df9b10f commit f1fffd9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/developing.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down

0 comments on commit f1fffd9

Please sign in to comment.