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

[MRG] Update README and fix <pre>...</pre> rendering #340

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

bharatr21
Copy link

@bharatr21 bharatr21 commented Jun 11, 2019

First off, thanks for the amazing project!

Few things which I had trouble from the README which could benefit many users:

  • Remove the $ from the bash commands to make it copy-pastable for users
  • Mention Quickstart Guide

Also remove the `$` from the bash commands to make it copy-pastable for users
@codecov-io
Copy link

Codecov Report

Merging #340 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #340   +/-   ##
=======================================
  Coverage   87.64%   87.64%           
=======================================
  Files          13       13           
  Lines        1505     1505           
  Branches      348      348           
=======================================
  Hits         1319     1319           
  Misses        129      129           
  Partials       57       57

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update de97be2...2f2275b. Read the comment docs.

@bharatr21 bharatr21 changed the title Update README and fix <pre>...</pre> rendering [MRG] Update README and fix <pre>...</pre> rendering Jun 13, 2019
@vinayak-mehta
Copy link
Contributor

The $ acts as a hint on where to run those commands, which are not very long. How does the '```bash' help here?

@bharatr21
Copy link
Author

@vinayak-mehta as mentioned above, removing the $ makes it easily copy-pastable for users in a bash shell and the '```bash' helps in syntax highlighting bash-specific commands such as cd, if any

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.

3 participants