Formatting and content updates for README.md #161
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Consistent use of Markdown headings: children of an h1 heading should be h2 headings - Consistent line wrapping: previously, some paragraphs were line-wrapped and others were not. This commit makes all paragraphs unwrapped. - Use `pip` for installation rather than `python setup.py` - Make it easier to copy-and-paste most command examples by removing `$` shell prompts - Remove unnecessary `GRANT` commands from mysql instructions: `%` is a wildcard so `'esi_leap'@'%'` already grants access to `'esi_leap'@'<database_ip>'` - Simplify the "Container Installation" section
tzumainn
approved these changes
Jun 28, 2024
| ``` | ||
| git clone https://github.com/CCI-MOC/esi-leap | ||
| cd esi-leap | ||
| pip install . |
There was a problem hiding this comment.
I have to admit, I didn't realize you could do this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
h2 headings
and others were not. This commit makes all paragraphs unwrapped.
pipfor installation rather thanpython setup.py$shell prompts
GRANTcommands from mysql instructions:%is a wildcard so'esi_leap'@'%'already grants access to'esi_leap'@'<database_ip>'