Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Investigate different format for README #168

Open
peter-tackage opened this issue Jul 17, 2017 · 3 comments
Open

Investigate different format for README #168

peter-tackage opened this issue Jul 17, 2017 · 3 comments
Labels

Comments

@peter-tackage
Copy link
Contributor

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
Copy link
Contributor

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

@tmtron
Copy link

tmtron commented Jul 24, 2017

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
Copy link
Contributor

pedpess commented Aug 23, 2017

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants