Skip to content

Commit

Permalink
Merge pull request jaybaird#5 from MPagel/patch-1
Browse files Browse the repository at this point in the history
Add installation instructions.
  • Loading branch information
joseph-fox authored Dec 13, 2016
2 parents c9adbd4 + 7e045ad commit 4d41391
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,25 @@ functions.
Development
***************
We follow this `git branching model <http://nvie.com/posts/a-successful-git-branching-model/>`_, please have a look at it.


*************************
Installation instructions
*************************
If you are installing from an internet-connected computer (or virtual install), you can use the pip python package manager to download and install this package. Simply type ``pip install pybloom-live`` from a DOS command prompt (``cmd.exe``) or a linux shell (e.g. ``bash`` or ``dash`` on MacOS X as well as linux OSes including debian, slackware, redhat, enoch and arch).

If using Windows and you are installing onto an airgapped computer or want the most up-to-date version from this repository, you can do the following:

1. Download the zip file by clicking on the green "Clone or Download" link followed by "Download Zip."
2. Extract all the contents of the the zip folder.
3. Open command prompt (``cmd.exe``) to the extracted folder.
a. Find the extracted folder in Windows Explorer.
b. From the parent folder level Shift+RightClick on the folder.
c. Select "Open command window here".
4. Type ``pip install .``.

Similar steps are possible under linux and MacOS X.

Installation verification
~~~~~~~~~~~~~~~~~~~~~~~~~
Type ``pip show pybloom-live`` from a command prompt. Version should be 2.2.0 as of 2016-12-11.

0 comments on commit 4d41391

Please sign in to comment.