just stepped through the readme file in the code:
Software is unworthy of release if it does not have a proper manpage.
This proves, that you are not only from FreeBSD world, you are probably more from the OpenBSD world! Looking at the code of bitcoin, there are too many people, which say "code is doc". Well, I can even remember a thread here, were Greg M is challenging others in reading code and asking to explain. This might prove him be a genius, but in companies you need team capabilities, not single point of failure knowledge. Reliability, combined with fall back scenarios is required. This is why good code is not only readable, but also documented. Otherwise the world would still be in (Z80 ?) assembler.
Thanks, pebwindkraft. Why yes, I think all the major BSDs have a strong manpage culture. I myself have much benefitted from that, and I have been inculcuated with it along the way.
I was there speaking to my annoyance at code only “documented” by wikis, webpages, or (for libraries) the output of Doxygen. If software lacks reasonably complete usage documentation which can be quickly referenced at the tty by typing `man xxx`, without firing up a web browser or even being online, then that severely impairs its usability.
From the producer end, it sometimes occurs that when writing a manpage, I realize that I am documenting a wish for what the program
should do, not what it actually does. Then, I change the code to bring it in line with the manpage. This happened repeatedly with
easyseed. Different levels of thought are required respectively for writing code, and explaining its external features in natural language. Exercising both improves the code.
I do believe that the code itself is a form of documentation; and I love reading well-written C code. For those who wish to modify the code, the code itself documents what it does; and code comments explain why, when that is nonobvious or based on some external specification. Written specifications are certainly needed for that teamwork you mention; and I judge specifications based on whether or not I need to refer to existing code to implement from spec. The manpage is most of all for those who wish to use the results; and ultimately, it is the results that count.
Appreciating your code distribution, looking at it, and trying to find out, what to do with it. Thanx for posting.
I hope that you find this utility useful for your Bech32 encoding needs. Please don’t hesitate to inquire with any questions or suggestions.