Skip to content

Commit

Permalink
More documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
safl committed Apr 1, 2015
1 parent f134250 commit 9bb519a
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions doc/source/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,15 @@ Installation
============

Benchpress is distributed as a Python package via PyPi. It can also be used directly from an unpacked tar-ball or from a git-clone.

From pypi.python.org
--------------------

The following shows how to do a user-mode / local installation::

pip install benchpress --user

Extend your ``$PATH``, such that the commands (`bp_run`, `bp_times`, `and bp_grapher`) are readily available::
Extend your ``$PATH``, such that the commands (`bp_run`, `bp_times`, `bp_compile`, `and bp_grapher`) are readily available::

export PATH=$PATH:$HOME/.local/bin

Expand All @@ -25,8 +29,8 @@ When using this approach uninstall is equally simple::
You can do a system-wide installation by omitting the ``--user`` flag. If you do a system-wide installation then extending ``$PATH`` is not required.
Additionally, implementations and suites will be avaiable are operating systems ``share`` location instead of ``.local``.

Running from source clone or tarball
------------------------------------
From clone or tarball
---------------------

Clone the repos::

Expand All @@ -40,13 +44,9 @@ or download and unpack tarball::
cd bohrium-benchpress-*

Then set your ``$PATH`` to the directory you have cloned or extracted to.
Or just invoke the tools, like so::

./bp_times
./bp_run
./bp_graph
Set your ``$PYTHONPATH`` to the benchpress subdirectory.

Running the Python benchmarks requires that the ``benchpress`` module is in your ``$PYTHONPATH``.
If you do not want to set paths then your working directory must be the root of the clone/tarball.

Cli
===
Expand All @@ -66,8 +66,8 @@ bp_grapher

...

Libraries / Modules
===================
Implementations / Libraries / Modules
=====================================

Python
------
Expand Down

0 comments on commit 9bb519a

Please sign in to comment.