Commit 6f0f40dc authored by Qusai Al Shidi's avatar Qusai Al Shidi 💬
Browse files

Bash markdown now has $ sign for better readability

parent a7a02802
......@@ -9,7 +9,7 @@ Git etiquette
If you're planning on adding a feature (new function or class) then create your own branch,
git checkout -b my_new_feature
$ git checkout -b my_new_feature
and start commiting there to test and work on. We will follow a [trunk-based development model]( This means we will rapidly merge branches once you have something stable and continue with master branch. So make sure to push something stable instead of being in your feature branch for too long. I will try to address your pull request ASAP.
......@@ -22,7 +22,7 @@ Coding Style: PEP 8
The style for your code must follow the [PEP 8]( style guide. It would be helpful to use a linter like [pylint]( to check whether your code is complying before submitting.
$ pylint
Coding Standard
......@@ -16,14 +16,14 @@ Clone into the directory you want to use it.
# Skip this if using it in SWMF directory.
git clone /path/to/my/dir
$ git clone /path/to/my/dir
Then go to its directory and run [pip]( to install. Make sure to include `--user`.
cd SWMF/share/Python/swmfpy # or your clone directory
pip install --user .
$ cd SWMF/share/Python/swmfpy # or your clone directory
$ pip install --user .
*Note*: Depending on your system [pip]( may be ran in several ways: `pip`, `pip3`, or `python3 -m pip`
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment