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

Improve INSTALL markdown formatting #100

Merged
merged 3 commits into from
Apr 19, 2017

Conversation

wilcoxjay
Copy link
Collaborator

When reading the INSTALL file as rendered on github, a few things are not as nice as they could be.

  • The installation instructions rendered so that all the shell commands were run together as normal text. I added additional spaces at the beginning of each line to convince github that the shell commands are code.
  • The file began with an emacs file variable line, which confused the renderer. Interestingly, simply deleting the line causes the file to be rendered as plain text. So I additionally renamed the file to end with a .md suffix. This has the unfortunate side effect of breaking existing references to the file (such as on the wiki where I originally found a reference to the INSTALL file, but probably there are others as well).

I realize that the original intention of this file was probably not to be read on github. But it is referred to by the wiki, and since the README is formatted so nicely for github, it seems like INSTALL should be, too.

When reading the INSTALL file on github, the instructions were rendering so that all the shell commands would be run together as normal text. Additional spaces convince github that the shell commands are code.
@msftclas
Copy link

This seems like a small (but important) contribution, so no Contribution License Agreement is required at this point. We will now review your pull request.
Thanks,
Microsoft Pull Request Bot

@wilcoxjay wilcoxjay changed the title Install markdown Improve INSTALL markdown formatting Apr 19, 2017
@cpitclaudel
Copy link
Member

Brilliant, thanks :)

@cpitclaudel cpitclaudel merged commit ef38da0 into dafny-lang:master Apr 19, 2017
@wilcoxjay wilcoxjay deleted the install-markdown branch August 23, 2017 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants