From: whitequark <whitequark@whitequark.org>
Date: Tue, 30 Jun 2020 22:26:54 +0000 (+0000)
Subject: docs: explain that `pip3 install -e` should be run after pulling.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=e240392fdb44fea5ceb64741c49d3bb8ac4a8220;p=nmigen.git

docs: explain that `pip3 install -e` should be run after pulling.
---

diff --git a/docs/install.rst b/docs/install.rst
index 59895fb..8d66fa3 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -111,6 +111,9 @@ Any changes made to the ``nmigen`` directory will immediately affect any code th
 
    $ cd nmigen
    $ git pull --ff-only origin master
+   $ pip3 install --editable .
+
+It is important to run the `pip3 install --editable .` each time the development snapshot is updated in case package dependencies have been added or changed.
 
 
 Installing board definitions