search

EnterpriseQualityCoding / FizzBuzzEnterpriseEdition

FizzBuzz Enterprise Edition is a no-nonsense implementation of FizzBuzz made by serious businessmen for serious business purposes.
21.29k stars 751 forks source link

Missing source tree view in readme #503

Open 5frank opened 3 years ago

5frank commented 3 years ago

I believe a complete tree view of the source directory should be added last to README.md to better illustrate that FizzBuzzEnterpriseEdition indeed is following best practice.

CTimmerman commented 3 years ago

I doubt enough users read the README.md nowadays, especially non-technical ones. ("What's an md file?")

Hosting on https://readthedocs.org/ is the solution. It is fully automatic, eliminating user error, provides alternative formats like PDF, and supports multiple versions of the same documentation. It only requires use of Sphinx, which uses reStructuredText (RST), the hipper Markdown that also supports LaTeX for proper typesetting. An added benefit of doing documentation through Git instead of Confluence or Wiki is that it's more in line with ITIL Change Management.