Investigate different format for README

[peter-tackage]

Working with a single monolithic README file can be difficult and sometimes makes the content difficult to consume. What are the alternatives and their pros and cons?

[joan-domingo]

I believe the only alternative in Github is to use the wiki feature
https://guides.github.com/features/wikis/

[tmtron]

AFAIK the wiki has the disadvantage, that only the master-branch is visible: see this SO-Answer

An alternative is to just create multiple .md files and use relative links. Then the users can just switch the branch in the GitHub web-page and see the corresponding files.

[pedpess]

We could use GitHub pages as well: https://pages.github.com/