Merge pull request #13 from Axelrod-Python/streamline-contribution-guidelines

Streamline the contribution guidelines.

Author: meatballs

CONTRIBUTING.rst

@@ -2,39 +2,6 @@
 Contributing
 ============
 
-Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given.
-
-Bug reports
-===========
-
-When `reporting a bug <https://github.com/meatballs/axelrod-fortran/issues>`_ please include:
-
-    * Your operating system name and version.
-    * Any details about your local setup that might be helpful in troubleshooting.
-    * Detailed steps to reproduce the bug.
-
-Documentation improvements
-==========================
-
-Axelrod Fortran could always use more documentation, whether as part of the
-official Axelrod Fortran docs, in docstrings, or even on the web in blog posts,
-articles, and such.
-
-Feature requests and feedback
-=============================
-
-The best way to send feedback is to file an issue at https://github.com/meatballs/axelrod-fortran/issues.
-
-If you are proposing a feature:
-
-* Explain in detail how it would work.
-* Keep the scope as narrow as possible, to make it easier to implement.
-* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
-
-Development
-===========
-
 To set up `axelrod-fortran` for local development:
 
 1. Fork `axelrod-fortran <https://github.com/meatballs/axelrod-fortran>`_
@@ -49,42 +16,18 @@ To set up `axelrod-fortran` for local development:
 
    Now you can make your changes locally.
 
-4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.io/en/latest/install.html>`_ one command::
-
-    tox
-
-5. Commit your changes and push your branch to GitHub::
-
-    git add .
-    git commit -m "Your detailed description of your changes."
-    git push origin name-of-your-bugfix-or-feature
-
-6. Submit a pull request through the GitHub website.
-
-Pull Request Guidelines
------------------------
-
-If you need some code review or feedback while you're developing the code just make the pull request.
-
-For merging, you should:
-
-1. Include passing tests (run ``tox``) [1]_.
-2. Update documentation when there's new API, functionality etc.
-3. Add a note to ``CHANGELOG.rst`` about the changes.
-4. Add yourself to ``AUTHORS.rst``.
-
-.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
-       `run the tests <https://travis-ci.org/meatballs/axelrod-fortran/pull_requests>`_ for each change you add in the pull request.
+4. To install a development version of the library::
 
-       It will be slower though ...
+    python setup.py develop
 
-Tips
-----
+   For this to work you also need the original Fortan code installed.
+   Instructions for this are available:
+   https://github.com/Axelrod-Python/TourExec
 
-To run a subset of tests::
+5. To run tests, `py.test` is used as a test runner::
 
-    tox -e envname -- py.test -k test_myfeature
+    pip install pytest
 
-To run all the test environments in *parallel* (you need to ``pip install detox``)::
+   To run the tests::
 
-    detox
+    pytest

README.rst

@@ -2,54 +2,6 @@
 Overview
 ========
 
-.. start-badges
-
-.. list-table::
-    :stub-columns: 1
-
-    * - docs
-      - |docs|
-    * - tests
-      - | |travis|
-        | |codecov|
-    * - package
-      - | |version| |wheel| |supported-versions| |supported-implementations|
-        | |commits-since|
-
-.. |docs| image:: https://readthedocs.org/projects/axelrod-fortran/badge/?style=flat
-    :target: https://readthedocs.org/projects/axelrod-fortran
-    :alt: Documentation Status
-
-.. |travis| image:: https://travis-ci.org/meatballs/axelrod-fortran.svg?branch=master
-    :alt: Travis-CI Build Status
-    :target: https://travis-ci.org/meatballs/axelrod-fortran
-
-.. |codecov| image:: https://codecov.io/github/meatballs/axelrod-fortran/coverage.svg?branch=master
-    :alt: Coverage Status
-    :target: https://codecov.io/github/meatballs/axelrod-fortran
-
-.. |version| image:: https://img.shields.io/pypi/v/axelrod-fortran.svg
-    :alt: PyPI Package latest release
-    :target: https://pypi.python.org/pypi/axelrod-fortran
-
-.. |commits-since| image:: https://img.shields.io/github/commits-since/meatballs/axelrod-fortran/v0.1.0.svg
-    :alt: Commits since latest release
-    :target: https://github.com/meatballs/axelrod-fortran/compare/v0.1.0...master
-
-.. |wheel| image:: https://img.shields.io/pypi/wheel/axelrod-fortran.svg
-    :alt: PyPI Wheel
-    :target: https://pypi.python.org/pypi/axelrod-fortran
-
-.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/axelrod-fortran.svg
-    :alt: Supported versions
-    :target: https://pypi.python.org/pypi/axelrod-fortran
-
-.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/axelrod-fortran.svg
-    :alt: Supported implementations
-    :target: https://pypi.python.org/pypi/axelrod-fortran
-
-
-.. end-badges
 
 Python wrapper for strategies originally written in Fortran
 
@@ -62,31 +14,9 @@ Installation
 
     pip install axelrod-fortran
 
-Documentation
-=============
-
-https://axelrod-fortran.readthedocs.io/
-
-Development
-===========
-
-To run the all tests run::
-
-    tox
 
-Note, to combine the coverage data from all the tox environments run:
-
-.. list-table::
-    :widths: 10 90
-    :stub-columns: 1
-
-    - - Windows
-      - ::
-
-            set PYTEST_ADDOPTS=--cov-append
-            tox
-
-    - - Other
-      - ::
+Contributing
+============
 
-            PYTEST_ADDOPTS=--cov-append tox
+Please see `CONTRIBUTING.rst` for details about installing for development and
+running the test suite.