Skip to content

Commit 4439658

Browse files
Adebayo120findleyr
authored andcommitted
Update readme generation instructions
1 parent 1dcbf62 commit 4439658

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,11 @@ The top-level `README.md` file is generated from `internal/readme/README.src.md`
111111
and should not be edited directly. To update the README:
112112

113113
1. Make your changes to `internal/readme/README.src.md`
114-
2. Run `make` in the `internal/readme/` directory to regenerate `README.md`
114+
2. Run `go generate ./internal/readme` from the repository root to regenerate `README.md`
115115
3. Commit both files together
116116

117117
The CI system will automatically check that the README is up-to-date by running
118-
`make` and verifying no changes result. If you see a CI failure about the
118+
`go generate ./internal/readme` and verifying no changes result. If you see a CI failure about the
119119
README being out of sync, follow the steps above to regenerate it.
120120

121121
## Timeouts

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ servers.
125125

126126
## Contributing
127127

128-
We welcome contributions to the SDK! Please see See
128+
We welcome contributions to the SDK! Please see
129129
[CONTRIBUTING.md](/CONTRIBUTING.md) for details of how to contribute.
130130

131131
## Acknowledgements / Alternatives

internal/readme/README.src.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ servers.
4848

4949
## Contributing
5050

51-
We welcome contributions to the SDK! Please see See
51+
We welcome contributions to the SDK! Please see
5252
[CONTRIBUTING.md](/CONTRIBUTING.md) for details of how to contribute.
5353

5454
## Acknowledgements / Alternatives

0 commit comments

Comments
 (0)