Merge pull request #120 from Islast/master

contributing docs updates
WhitakerLab · Jun 17, 2019 · 1e70f46 · 1e70f46
2 parents 8dfb892 + 18b8047
commit 1e70f46
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -196,4 +196,4 @@ And if you've found typos in this (or any other) page, you could consider submit
 [link_hatrackhome]: https://labhr.github.io/
 [link_hatrackidea]: http://hawthornlandings.org/2015/02/13/a-place-to-hang-your-hat/
 [link_hatrackcontributions]: http://opensource.com/life/15/10/octohat-github-non-code-contribution-tracker
-[link_fixingtyposissue]: https://github.com/WhitakerLab/scona//issues/4
+[link_fixingtyposissue]: https://github.com/WhitakerLab/scona//issues/4
diff --git a/DEVELOPMENT_GUIDE.md b/DEVELOPMENT_GUIDE.md
@@ -14,14 +14,15 @@ The [development guide](#development-guide) deals with the specifics of contribu
 
 ### Installing in editable mode
 
-Use `pip install -e git+https://github.com/WhitakerLab/scona.git` to install scona in editable mode. This means that the python install of scona will be kept up to date with any changes you make, including switching branches in git.
+Use `pip install -e git+https://github.com/WhitakerLab/scona.git#egg=scona` to install scona in editable mode. This means that the python install of scona will be kept up to date with any changes you make, including switching branches in git.
 
 ### Linting
 
 scona uses the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/).
 You can use [flake8](http://flake8.pycqa.org/en/latest/) to lint code.
 We're quite a young project (at time of writing in January 2019) and so we aren't going to be super hardcore about your linting!
 Linting should make your life easier, but if you're not sure how to get started, or if this is a barrier to you contributing to `scona` then don't worry about it or [get in touch](CONTRIBUTING.md#how-to-get-in-touch) and we'll be happy to help you.
+Feel free also to correct unlinted code in scona when you come across it!:sparkles:
 
 ### Writing docstrings
 

diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ If you don't want to bother reading the whole of this page, here are three place
 * To install `scona` as a python package with pip
 
 ```
-pip install git+https://github.com/WhitakerLab/scona.git
+pip install git+https://github.com/WhitakerLab/scona.git#egg=scona
 ```
 
 * Check out our [tutorial](tutorials/tutorial.ipynb) for examples of basic functionality.