dannyedel
commented
9 years ago Since this is mainly about simplification and deduplication, here's the idea what goes to the webpage:
- Short introduction "What does it do?"
- Maybe later: some screenshots of example presentations
- Usage instructions, probably auto-built from the manpage in the source
- Installation instructions "How do I get it?"
- Split those by operating system
- List only binary instructions up top
- List source instructions on their own page
- Contribution instructions "How can I help?"
- Link to issue tracker for questions/problems/enhancement suggestions
- Link to github repository of program and this webpage
After this page is built, clean up in the actual source tree:
- Drop all installation instructions from README.md, leaving just a link to the (rendered) webpage
- List basic "from source" install instructions (debuild and generic cmake) in the INSTALL file
Use github's pages feature to generate a small website about the program
replaces #44 since the main purpose was to make the readme more visible