Update readme generation instructions
This commit is contained in:
parent
1dcbf62661
commit
4439658dc4
1 changed files with 4 additions and 4 deletions
|
|
@ -111,11 +111,11 @@ The top-level `README.md` file is generated from `internal/readme/README.src.md`
|
|||
and should not be edited directly. To update the README:
|
||||
|
||||
1. Make your changes to `internal/readme/README.src.md`
|
||||
2. Run `make` in the `internal/readme/` directory to regenerate `README.md`
|
||||
2. Run `go generate ./internal/readme` from the repository root to regenerate `README.md`
|
||||
3. Commit both files together
|
||||
|
||||
The CI system will automatically check that the README is up-to-date by running
|
||||
`make` and verifying no changes result. If you see a CI failure about the
|
||||
`go generate ./internal/readme` and verifying no changes result. If you see a CI failure about the
|
||||
README being out of sync, follow the steps above to regenerate it.
|
||||
|
||||
## Timeouts
|
||||
|
|
|
|||
Loading…
Reference in a new issue