diff --git a/README.md b/README.md index 9c2f00b3..b552925a 100644 --- a/README.md +++ b/README.md @@ -216,6 +216,15 @@ Install packages: To activate this project's virtualenv, run the following: $ pipenv shell +Install from git: + + $ pipenv install -e git+https://github.com/requests/requests.git@v2.19.1#egg=requests + Installing -e git+https://github.com/requests/requests.git@v2.19.1#egg=requests… + ... + Adding -e git+https://github.com/requests/requests.git@v2.19.1#egg=requests to Pipfile's [packages]... + +You can also change the tag/ref (or exclude to get the latest version) by adding @version-or-tag before #egg=project_name + Install a dev dependency: $ pipenv install pytest --dev diff --git a/news/2685.doc b/news/2685.doc new file mode 100644 index 00000000..6f2a0aff --- /dev/null +++ b/news/2685.doc @@ -0,0 +1 @@ +Added simple example to README.md for installing from git.