Skip to content

Add installation instructions for gfmrun #2177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dearchap merged 2 commits into from
Aug 9, 2025
+12 −0
Merged

Add installation instructions for gfmrun #2177

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e08c80
Add installation instructions for gfmrun
jllovet Aug 9, 2025
47044b9
Update docs/CONTRIBUTING.md
dearchap Aug 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,18 @@ verify one's changes are harmonious in nature. The same steps are also run durin
[continuous integration
phase](https://github.com/urfave/cli/blob/main/.github/workflows/test.yml).

`gfmrun` is required to run the examples, and without it `make all` will fail.

You can find `gfmrun` here:

- [urfave/gfmrun](https://github.com/urfave/gfmrun)

To install `gfmrun`, you can use `go install`:

```
go install github.com/urfave/gfmrun/cmd/gfmrun@latest
```

In the event that the `v3diff` target exits non-zero, this is a signal that the public API
surface area has changed. If the changes are acceptable, then manually running the
approval step will "promote" the current `go doc` output:
Expand Down
Loading