From 288938ab72bc4d17d5d818fcbe45cd8cb03ae2e1 Mon Sep 17 00:00:00 2001 From: Marc Abramowitz Date: Sat, 19 Apr 2014 08:44:17 -0700 Subject: [PATCH] README.rst: Add links Change-Id: Ia784781c9142f7a9deaeef812c6c95a936342f3a --- README.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 5dbdcc16c..28565874a 100644 --- a/README.rst +++ b/README.rst @@ -37,9 +37,9 @@ More details on how you can contribute is available on our wiki at: Writing a patch =============== -We ask that all code submissions be pep8 and pyflakes clean. The -easiest way to do that is to run `tox` before submitting code for -review in Gerrit. It will run `pep8` and `pyflakes` in the same +We ask that all code submissions be pep8_ and pyflakes_ clean. The +easiest way to do that is to run tox_ before submitting code for +review in Gerrit. It will run ``pep8`` and ``pyflakes`` in the same manner as the automated test suite that will run on proposed patchsets. @@ -60,12 +60,18 @@ implementation. Installing without setup.py =========================== -For YAML support, you will need libyaml installed. +For YAML support, you will need libyaml_ installed. Mac OS X:: $ brew install libyaml -Then install the required python packages using pip:: +Then install the required python packages using pip_:: $ sudo pip install PyYAML python-jenkins + +.. _pep8: https://pypi.python.org/pypi/pep8 +.. _pyflakes: https://pypi.python.org/pypi/pyflakes +.. _tox: https://testrun.org/tox +.. _libyaml: http://pyyaml.org/wiki/LibYAML +.. _pip: https://pypi.python.org/pypi/pip