Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upManpage, helping hand needed #790
Open
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment


Hi all,
if you pull an update you will notice that there's a doc directory. I committed today the draft version of the manpage. This was for a long time an open issue (#130) and kind of painful to me as I think a tool needs a proper documentation, also if it is somewhat self explanatory.
This documentation (in md format, see below) could need some helping hands:
* for finalizing (see hidden comments)
* proofreading 1: accuracy, logic, more content related issues
* proofreading 2: grammar, spelling (I am not a native speaker and didn't proofreading myself)
* more? pls let me know
In the doc directory there are two files: a markdown file and a file in the usual manpage format (roff) which was generated from the first one (
ronn -r testssl.1.md).For now the master format is markdown, this is until the content has matured. For medium terms it is something which needs to be reconsidered as markdown as the source format for documentation has IMO too many limits. I am everything else than an expert here, so I am happy for suggestions for
Thx, Dirk