Merge pull request #33 from materialsproject/tschaume-patch-1

README: editable install
materialsproject · Apr 12, 2018 · 549faf6 · 549faf6
2 parents f34c029 + f87bd16
commit 549faf6
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,11 @@ Emmet is currently primarily an internal Materials Project tool so if you're rea
 
 ## Installation
 
-Emmet is on PyPI, so `pip install emmet` should work. However, it is currently in very active development, so cloning the git repo and `python setup.py develop` is recommended for now.
+Emmet is on PyPI, so `pip install emmet` should work. However, it is currently in very active development, so an editable install is recommended for now:
+
+```bash
+pip install -e git+git@github.com:materialsproject/emmet.git#egg=emmet --src .
+```
 
 ## Running a Builder
 
@@ -169,4 +173,4 @@ The VASP builders all operate on a `tasks` Store which is parsed from *any* VASP
 
 2. It then finds the task corresponding to a static calculation.
 
-3. If `AECCAR0`, `AECCAR2`, `CHGCAR` are present, performs attempts to find bonding information using critic2 and also performs a bader analysis that is stored separately.
+3. If `AECCAR0`, `AECCAR2`, `CHGCAR` are present, performs attempts to find bonding information using critic2 and also performs a bader analysis that is stored separately.