Skip to content

Commit

Permalink
docs: updated quick-start
Browse files Browse the repository at this point in the history
  • Loading branch information
safl committed Dec 19, 2018
1 parent 54ddb49 commit 0d478d2
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,22 @@
Quick Start
=============

Install **cijoe** via the Python Package index:
Install **cijoe** system-wide via the pip:

.. code-block:: bash
sudo pip install cijoe
Or install it user-level:

.. code-block:: bash
pip install cijoe
.. note:: When doing user-level install, then include the :code:`pip` binary
install path in your :code:`PATH` definition. For example
:code:`PATH="$PATH:$HOME/.local/bin"`

Run **cijoe** interactively and define the target environment:

.. code-block:: bash
Expand All @@ -23,7 +33,7 @@ Run **cijoe** interactively and define the target environment:
# Open up your favorite editor and modify accordingly
vim target_env.sh
Start the test-runner and view the report:
Invoke the test runner, generate report and inspect the result:

.. code-block:: bash
Expand Down

0 comments on commit 0d478d2

Please sign in to comment.