Skip to content

Commit

Permalink
Readme consistency and more syntax highlighting
Browse files Browse the repository at this point in the history
  • Loading branch information
danielgtaylor committed Feb 5, 2015
1 parent 12ec18d commit 0f97cf8
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ pull requests on this repository. Thanks!

Quick Start
-----------
First, install the library and set a default region::
First, install the library and set a default region:

.. code-block:: sh
$ pip install boto3
Expand Down Expand Up @@ -75,7 +77,9 @@ Getting Started
~~~~~~~~~~~~~~~
Assuming that you have Python and ``virtualenv`` installed, set up your
environment and install the required dependencies like this instead of
the ``pip install boto3`` defined above::
the ``pip install boto3`` defined above:

.. code-block:: sh
$ git clone https://github.com/boto/boto3.git
$ cd boto3
Expand All @@ -91,20 +95,26 @@ You can run tests in all supported Python versions using ``tox``. Be default,
it will run all of the unit tests, but you can also specify your own
``nosetests`` options. Note that this requires that you have all supported
versions of Python installed, otherwise you must pass ``-e`` or run the
``nosetests`` command directly::
``nosetests`` command directly:

.. code-block:: sh
$ tox
$ tox tests/unit/test_session.py
$ tox -e py26,py33 tests/integration
You can also run individual tests with your default Python version::
You can also run individual tests with your default Python version:

.. code-block:: sh
$ nosetests tests/unit
Generating Documentation
~~~~~~~~~~~~~~~~~~~~~~~~
Sphinx is used for documentation. You can generate HTML locally with the
following::
following:

.. code-block:: sh
$ pip install sphinx sphinx_rtd_theme
$ cd docs
Expand Down

0 comments on commit 0f97cf8

Please sign in to comment.