search

futurice / android-best-practices

Do's and Don'ts for Android development, by Futurice developers
Other
20.35k stars 3.37k forks source link

Investigate different format for README #168

Open peter-tackage opened 7 years ago

peter-tackage commented 7 years ago

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 commented 7 years ago

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

tmtron commented 7 years ago

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 commented 7 years ago

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