From b55a129a40804d260be07a44cdb902bb631d2c08 Mon Sep 17 00:00:00 2001 From: Adam Date: Sat, 4 Oct 2025 00:07:13 +0100 Subject: [PATCH] Update readme generation instructions --- CONTRIBUTING.md | 4 ++-- README.md | 2 +- internal/readme/README.src.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 726ac95f..001c35d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index 81af0b09..2a2d4083 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/internal/readme/README.src.md b/internal/readme/README.src.md index e83c5fc4..cdc2cd68 100644 --- a/internal/readme/README.src.md +++ b/internal/readme/README.src.md @@ -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