diff options
| author | Marc Abramowitz <marc@marc-abramowitz.com> | 2014-04-19 08:44:17 -0700 |
|---|---|---|
| committer | Marc Abramowitz <marc@marc-abramowitz.com> | 2014-04-19 08:48:53 -0700 |
| commit | 288938ab72bc4d17d5d818fcbe45cd8cb03ae2e1 (patch) | |
| tree | 45d00096fb47c253a0a1a229a60417ca2cf10659 /README.rst | |
| parent | ad433112039e9d1d6d616d89ed8038730ec46f3f (diff) | |
| download | python-jenkins-job-builder-288938ab72bc4d17d5d818fcbe45cd8cb03ae2e1.tar.gz python-jenkins-job-builder-288938ab72bc4d17d5d818fcbe45cd8cb03ae2e1.tar.xz python-jenkins-job-builder-288938ab72bc4d17d5d818fcbe45cd8cb03ae2e1.zip | |
README.rst: Add links
Change-Id: Ia784781c9142f7a9deaeef812c6c95a936342f3a
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 16 |
1 files changed, 11 insertions, 5 deletions
@@ -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 |