Readme and contributing changes #543
Conversation
* Split 'Locations and Formats' * Rewrite 'Formats' paragraph
| But this does not mean that you have to write it in Markdown as well. | ||
|
|
||
| The following list contains more detailed instructions for different formats: | ||
| * Markdown: Nothing to do. |
There was a problem hiding this comment.
For Jekyll, before you start a list you need a empty line. Although this will be render correctly at GitHub preview I would like to enforce a empty line before this one.
|
I'd like to verify all of the installation instructions while also reviewing content. Is there a jenkins job or something similar that does all of the installation steps then runs through rendering of pages? If there isn't, then I'd be cautious about over-specifying how to install things. Usually I link out to a project's installation instructions because their install docs will be more up to date than mine. But, if there is an automated way to install all the requirements and build the site, then I am more okay with keeping the detailed installation instructions here since we'd know when they break. |
|
Work also being done in #544 . Feel free to chip in! |
|
@codersquid Verifying installation instructions is beyond the scope of what I want to do. |
* Make the word 'Makefile' stand out * Fix Markdown mark-up
|
@gvwilson If there are no further requests, this should be ready to merge. |
…nges Readme and contributing changes
Greg asked volunteers to review these two files ([Discuss] volunteer wanted to clarify README.md and CONTRIBUTING.md) and I did. Feel free to comment.
After squashing (and accidentally squashing too much and splitting again) I put the stuff into a new branch. At least, rebuilding history with Git works well. First pull request was #537.
Feedback on how I should have done this instead are welcome ;D