diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 16 |
1 files changed, 11 insertions, 5 deletions
@@ -39,9 +39,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. @@ -62,12 +62,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 |