From ea716db8d28d4e39728cd3dfbaadabf75376dbf8 Mon Sep 17 00:00:00 2001
From: Keerthan Jaic <jckeerthan@gmail.com>
Date: Sat, 2 Feb 2019 22:15:16 -0500
Subject: [PATCH] update installation instructions

fixes #295
---
 README.md | 30 ++++++++++++++++--------------
 1 file changed, 16 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index f95e6fc3..e0b0d2b0 100644
--- a/README.md
+++ b/README.md
@@ -38,28 +38,30 @@ To find out what's new in this release, please read:
 
 Installation
 ------------
-If you have superuser power, you can install MyHDL as follows:
+It is recommended to install MyHDL (and your project's other dependencies) in
+a virtualenv.
+
+Installing the latest stable release:
 
 ```
-python setup.py install
+pip install myhdl
 ```
 
-This will install the package in the appropriate site-wide Python
-package location.
-
-Otherwise, you can install it in a personal directory, e.g. as
-follows:
-
+To install the development version from github:
 ```
-python setup.py install --home=$HOME
+pip install -e 'git+https://github.com/myhdl/myhdl#egg=myhdl
 ```
 
-In this case, be sure to add the appropriate install dir to the
-``$PYTHONPATH``.
+To install a local clone of the repository:
+```
+pip install -e path/to/dir
+```
+
+To install a specific commit hash, tag or branch from git:
+```
+pip install -e 'git+https://github.com/myhdl/myhdl@f696b82ca5c9e3668920d1b66263941dcbcf08b6#egg=myhdl
+```
 
-If necessary, consult the distutils documentation in the standard
-Python library if necessary for more details;
-or contact me.
 
 You can test the proper installation as follows: