Update README.rst

This commit is contained in:
Michael Lazar
2016-03-03 20:05:36 -08:00
parent 757086fcf8
commit e7f366c9c2

View File

@@ -32,15 +32,15 @@ Install using pip...
.. code-block:: bash
$ pip install rtv
$ pip install rtv
or clone the repository.
.. code-block:: bash
$ git clone https://github.com/michael-lazar/rtv.git
$ cd rtv
$ python3 setup.py install
$ git clone https://github.com/michael-lazar/rtv.git
$ cd rtv
$ python3 setup.py install
=====
Usage
@@ -50,7 +50,7 @@ To run the program, type
.. code-block:: bash
$ rtv --help
$ rtv --help
--------
Controls
@@ -96,7 +96,7 @@ Auto-generate the config file by running
.. code-block:: bash
$ rtv --copy-config
$ rtv --copy-config
See the `default config <https://github.com/michael-lazar/rtv/blob/master/rtv/rtv.cfg>`_ for the full list of settings.
@@ -109,7 +109,7 @@ Set the editor by changing ``$RTV_EDITOR`` in your environment.
.. code-block:: bash
$ export RTV_EDITOR=gedit
$ export RTV_EDITOR=gedit
If not specified, the default system ``$EDITOR`` (or *nano*) will be used.
@@ -123,7 +123,7 @@ If you prefer the complete terminal experience, set ``$BROWSER`` to a console-ba
.. code-block:: bash
$ export BROWSER=w3m
$ export BROWSER=w3m
`w3m <http://w3m.sourceforge.net/>`_, `lynx <http://lynx.isc.org/>`_, and `elinks <http://elinks.or.cz/>`_ are all good choices.
@@ -156,10 +156,10 @@ How do I run the repository code directly?
$ python3 -m rtv
How do I run the tests?
This project uses `pytest <http://pytest.org/>`_ and `VCR.py <https://vcrpy.readthedocs.org/>`_
to facilitate testing.
This project uses `pytest <http://pytest.org/>`_ and `VCR.py <https://vcrpy.readthedocs.org/>`_.
.. code-block:: bash
$ pip3 install pytest
$ # The pip release for VCR.py is out-of-date
$ pip3 install git+https://github.com/kevin1024/vcrpy.git
@@ -175,7 +175,7 @@ How do I run the tests?
.. code-block:: bash
$ PYTHONPATH=. py.test --record-mode=once --refresh-token=~/.config/rtv/refresh-token
$ PYTHONPATH=. py.test --record-mode=once --refresh-token=~/.config/rtv/refresh-token
=========
Changelog