Investigate different format for README

Question

Investigate different format for README

peter-tackage opened this issue 7 years ago · comments

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 · Answer 1 · Mon Jul 24 2017 20:30:29 GMT+0800 (China Standard Time)

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

TMTron · Answer 2 · Mon Jul 24 2017 20:53:22 GMT+0800 (China Standard Time)

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.

Pedro Pessoa · Answer 3 · Thu Aug 24 2017 04:03:32 GMT+0800 (China Standard Time)

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