Skip to content

Commit

Permalink
Merge pull request #144 from dodevops/bugfix/te/doc-mkdoc-fix
Browse files Browse the repository at this point in the history
fix: Fixing README template section about building README.md
  • Loading branch information
timdeluxe authored Jun 27, 2024
2 parents bc91cd5 + 380fb7c commit 61efb42
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -811,7 +811,7 @@ you can inspect the failing container as well.

To rebuild this documentation, first compile the documentation maker:

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

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

Expand Down
2 changes: 1 addition & 1 deletion README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ you can inspect the failing container as well.

To rebuild this documentation, first compile the documentation maker:

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

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

Expand Down

0 comments on commit 61efb42

Please sign in to comment.