modelcontextprotocol/go-sdk
Watch
1
0
Fork
You've already forked go-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Update readme generation instructions

Browse source
This commit is contained in:
Adam 2025-10-04 00:07:13 +01:00 • committed by Robert Findley
commit 4439658dc4
3 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -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

2
README.md
View file

@ -125,7 +125,7 @@ servers.
## Contributing
We welcome contributions to the SDK! Please see See
We welcome contributions to the SDK! Please see
[CONTRIBUTING.md](/CONTRIBUTING.md) for details of how to contribute.
## Acknowledgements / Alternatives

2
internal/readme/README.src.md
View file

@ -48,7 +48,7 @@ servers.
## Contributing
We welcome contributions to the SDK! Please see See
We welcome contributions to the SDK! Please see
[CONTRIBUTING.md](/CONTRIBUTING.md) for details of how to contribute.
## Acknowledgements / Alternatives