search

decred / gominer

Go (golang) based GPU miner for Decred.
GNU General Public License v3.0
160 stars 80 forks source link

Documentation #155

Closed gratefulcheddar closed 1 year ago

gratefulcheddar commented 7 years ago

I was thinking about walking through the entire gominer code and adding comments where needed and possibly creating some UML documentation (sequence diagrams?). Does anyone else think it would be worthwhile?

jcvernaleo commented 7 years ago

I personally never got into UML but it certainly couldn't hurt. Parts of gominer are probably documented fairly well but I know some parts are very light.

I always liked the idea of gominer as an example cc miner so more docs might be good from that front.

jolan commented 7 years ago

More comments would be good. Another thing would be to clean up the magic numbers where the block header is copied/modified. For example add constants for NONCE_BEGIN NONCE_END and replace the numbers with those constants.