Add documentation?

[u-root]

Add documentation?

[hugelgupf]

I would suggest starting with moving the godoc to the readme. https://github.com/u-root/cpu/blob/master/cmds/cpu/doc.go @rminnich

[mpictor]

The files cpu/doc.go and cpud/doc.go are identical. Is this intentional?

Rather than duplicating the documentation from godoc, what about specifically mentioning godoc in the README?

Also, the URL for the godoc icon in the README should be updated to point to u-root/cpu - currently it points to godoc for u-root/u-root.

[mpictor]

I'd also like to see documentation of how to create the keys, and whether any specific kernel options must be enabled/disabled; so far I've manged to get cpu to spit out the key I pass to it, complaining of a short read, or to tell me connection reset by peer.

[orangecms]

Coming back to this:
I had drafted initial notes in https://github.com/orangecms/arm-cpu#executing-over-cpu
I'll see that I can find some time again to expand that and get it in here.

[orangecms]

We've configured https://book.linuxboot.org/ for a start and Ron added a few links to the cpu chapter in it and talks featuring cpu to the README; WDYT @stapelberg, is that a good start?

[stapelberg]

Thanks, https://book.linuxboot.org/cpu/ is a good read and indeed answers my questions! :)

[orangecms]

Awesome, thank you! We've extended the README even more and added the link to the cpu chapter in the book. Closing then, enjoy cpu! :)