Integrate goreadme about script

[bitfield]

Let's try GitHub Actions! I've been using CircleCI up to now, but my sense is that Actions should be able to replace a lot of what CircleCI currently does.

[mainawycliffe]

Yeah, GitHub Actions can replace Circle CI Completely.

[mrKappen]

oh whoops. I would be happy to take a look @bitfield .

[mainawycliffe]

Yeah, I think so. Let me work on the GitHub Action workflow and create a PR.

[mainawycliffe]

I would love to take a crack at this, if its still open.

[bitfield]

Certainly!

[mainawycliffe]

I am just going through this, I can see there is a number of options to implement this like using GitHub Actions and GitHub Apps. I also think it might be possible to hook it up to any other CI. Do you have any particular preference?

[mrKappen]

I think this issue can be closed @bitfield

[bitfield]

Well, we haven't actually done it yet! If you're looking for something interesting to pick up, @mrKappen, feel free to look at this one!

[mainawycliffe]

@bitfield I have been playing with goreadme and couldn't get it to generate docs for structure methods, just the top level, structure docs. So I decided to do some digging and came across gomarkdoc which does generate the docs as expected, here are the docs I was able to generate.

[bitfield]

Looks awesome @mainawycliffe! Nice job!

Could you run up a PR to move the existing text from the README into a doc.go file, and add a GitHub Action to autogenerate the README from it?

[mainawycliffe]

after further play with the gomarkdoc tool, it's possible to generate the complete read me, but it will require moving the package intro section of the read me as a package comment, it works for the most part, but it's not compatible with markdown, but can be adopted to be somewhat decent.

[bitfield]

Great! Would you like to try this, and see how far you can get?

[mainawycliffe]

Yeah, I would like to do that.