Skip to content
This repository has been archived by the owner on Mar 2, 2022. It is now read-only.

Commit

Permalink
Merge pull request #91 from juga0/feature/readme_pythonversion
Browse files Browse the repository at this point in the history
Add installation system requirements and Python version
  • Loading branch information
aagbsn authored Mar 19, 2018
2 parents 500398f + f138544 commit cd023b2
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ This project is still under active development and is not ready for active use o
Installation
------------

BWScanner is not yet compatible with Python 3 due to the `txsocksx ` dependency.

In Debian/Ubuntu systems, you can install Python 2 and other systems
requirements running:

.. code:: bash
sudo apt install python2.7 python2.7-dev
The bandwidth scanner and its dependencies can be installed as follows:

.. code:: bash
Expand All @@ -23,11 +32,20 @@ The bandwidth scanner and its dependencies can be installed as follows:
cd bwscanner
python setup.py install
In case your system is using Python 3 by default, you need to run Python 2
explicitely, changing last line by:

.. code:: bash
python2.7 setup.py install
Running
-------

After installation the ``bwscan`` tool should be available in your path. This tool has a number of subcommands for running scans and for aggregating the collected data for use by the bandwidth authorities.


Collecting bandwidth measurements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit cd023b2

Please sign in to comment.