Closed sorashi closed 5 years ago
This is a great idea, howevr I don't like the website content being duplicated... any idea how we could avoid that?
@flakes I'm not sure whether I fully understand what you mean.
If you mean that the readme is just a duplicate of the website content and that's inappropriate, then we could re-create the readme to contain just a short description of the project and then refer to the website for the rest. Is that okay?
If you mean there should be a mechanism to make it easier to mirror the content from the website (which is just the gh-pages branch) to the readme, then that's possible, but would be much easier if the website was transferred to Jekyll.
Keep the intro explaining the program and link to the website. Point to Download/Changelog/FAQ webpages instead of duplicating its content.
Complete the readme with info that is useful for (new) developers, how to make a proper bug report ect.
I made the changes
Readme screenshot:
Nice work, thanks!
I think all GitHub repositories should contain a readme to give the reader a quick overview of the project without leaving GitHub. In this PR I created a readme from the website branch content and I also moved the contents of FAQ.md into the readme. The latter is in a separate commit if you'd happen to want to revert that and keep just the readme.