Skip to content

Commit 0990cb1

Browse files
author
darothen
committed
Closes #11; I added a note to the README which emphasizes the need to run setup.py. I think this is important because there are so many dependencies for the package that the user really should be leaning on the standard packaging tools to ensure that things are installed properly.
1 parent 6a27e23 commit 0990cb1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.rst

+6
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,12 @@ or, you can install via pip directly from git::
8484

8585
$ pip install git+https://github.com/darothen/xbpch.git
8686

87+
Please note that if you locally clone the repository from GitHub but do not
88+
explicitly install the package using ``setup.py``, the file ``xbpch/version.py``
89+
will not get written properly and you will not be able to use the package.
90+
We strongly recommend you install the package using traditional techniques to
91+
ensure that all dependencies are properly added to your environment.
92+
8793
Quick Start
8894
-----------
8995

0 commit comments

Comments
 (0)