Skip to content

Commit ba5d54b

Browse files
authored
Merge pull request #2177 from jllovet/contributor-docs
Add installation instructions for gfmrun
2 parents 32d2668 + 47044b9 commit ba5d54b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,18 @@ verify one's changes are harmonious in nature. The same steps are also run durin
6666
[continuous integration
6767
phase](https://github.com/urfave/cli/blob/main/.github/workflows/test.yml).
6868

69+
`gfmrun` is required to run the examples, and without it `make all` will fail.
70+
71+
You can find `gfmrun` here:
72+
73+
- [urfave/gfmrun](https://github.com/urfave/gfmrun)
74+
75+
To install `gfmrun`, you can use `go install`:
76+
77+
```
78+
go install github.com/urfave/gfmrun/cmd/gfmrun@latest
79+
```
80+
6981
In the event that the `v3diff` target exits non-zero, this is a signal that the public API
7082
surface area has changed. If the changes are acceptable, then manually running the
7183
approval step will "promote" the current `go doc` output:

0 commit comments

Comments
 (0)