Skip to content

Commit 61efb42

Browse files
authored
Merge pull request #144 from dodevops/bugfix/te/doc-mkdoc-fix
fix: Fixing README template section about building README.md
2 parents bc91cd5 + 380fb7c commit 61efb42

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -811,7 +811,7 @@ you can inspect the failing container as well.
811811

812812
To rebuild this documentation, first compile the documentation maker:
813813

814-
docker run --rm -e GOOS=[os, e.g. darwin, linux, windows] -e GOARCH=[architecture, e.g. arm64, amd64] -v "$PWD":/usr/src/myapp -w /usr/src/myapp golang:1.19-alpine go run cmd/doc/mkdoc
814+
docker run --rm -e GOOS=[os, e.g. darwin, linux, windows] -e GOARCH=[architecture, e.g. arm64, amd64] -v "$PWD":/usr/src/myapp -w /usr/src/myapp golang:1.19-alpine go build cmd/doc/mkdoc.go
815815

816816
Then run it to rebuild README.md based on README.md.gotmpl:
817817

README.md.gotmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ you can inspect the failing container as well.
438438

439439
To rebuild this documentation, first compile the documentation maker:
440440

441-
docker run --rm -e GOOS=[os, e.g. darwin, linux, windows] -e GOARCH=[architecture, e.g. arm64, amd64] -v "$PWD":/usr/src/myapp -w /usr/src/myapp golang:1.19-alpine go run cmd/doc/mkdoc
441+
docker run --rm -e GOOS=[os, e.g. darwin, linux, windows] -e GOARCH=[architecture, e.g. arm64, amd64] -v "$PWD":/usr/src/myapp -w /usr/src/myapp golang:1.19-alpine go build cmd/doc/mkdoc.go
442442

443443
Then run it to rebuild README.md based on README.md.gotmpl:
444444

0 commit comments

Comments
 (0)