Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: fix online godoc link and rebuild #162

Merged
merged 1 commit into from
Aug 1, 2023

Conversation

dolmen
Copy link
Contributor

@dolmen dolmen commented Jun 12, 2023

README.md:

  • fix GoDoc badge to use pkg.go.dev
  • fix "go get" instruction to use module style
  • fix build instruction to patch godocdown output to handle how section titles are formatted by gofmt in Go 1.18+: add sed -i= 's/^# /### /' README.md step
  • rebuild README.md

Build instructions:

$ go install github.com/robertkrimen/godocdown/godocdown@latest
$ godocdown -template=.godocdown.template -o README.md
$ sed -i= 's/^# /### /' README.md

README.md:
* fix GoDoc badge to use pkg.go.dev
* fix "go get" instruction to use module style
* fix build instruction to patch godocdown output to handle how section titles
  are formatted by gofmt in Go 1.18+
* rebuild README.md

Build instructions:

   go install github.com/robertkrimen/godocdown/godocdown@latest
   godocdown -template=.godocdown.template -o README.md
   sed -i= 's/^# /### /' README.md
@dolmen dolmen mentioned this pull request Jun 12, 2023
Copy link
Owner

@frankban frankban left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for this!

@frankban frankban merged commit 7c937a9 into frankban:master Aug 1, 2023
8 checks passed
@frankban
Copy link
Owner

frankban commented Aug 1, 2023

Released as v1.14.6.

frankban added a commit that referenced this pull request Mar 1, 2024
README: fix online godoc link and rebuild
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants