Skip to content

Commit e5c9345

Browse files
committed
Modifying README.
1 parent bce069e commit e5c9345

File tree

1 file changed

+10
-59
lines changed

1 file changed

+10
-59
lines changed

README.rst

Lines changed: 10 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,15 @@
1-
.. image:: https://badge.waffle.io/Axelrod-Python/Axelrod.svg?label=ready&title=Ready
2-
:target: https://waffle.io/Axelrod-Python/Axelrod
3-
4-
5-
.. image:: https://coveralls.io/repos/Axelrod-Python/Axelrod/badge.svg
6-
:target: https://coveralls.io/r/Axelrod-Python/Axelrod
7-
8-
.. image:: https://img.shields.io/pypi/v/Axelrod.svg
9-
:target: https://pypi.python.org/pypi/Axelrod
10-
11-
.. image:: https://travis-ci.org/Axelrod-Python/Axelrod.svg?branch=packaging
12-
:target: https://travis-ci.org/Axelrod-Python/Axelrod
13-
141
|Join the chat at https://gitter.im/Axelrod-Python/Axelrod|
152

16-
Results
17-
=======
18-
19-
This repository contains Python code that reproduces the
20-
tournament. To run the tournament, you simply need to:
21-
22-
::
23-
24-
$ python run_axelrod
25-
26-
This automatically outputs a ``svg`` file with the results. You can see
27-
the results from the latest run of the tournament here:
28-
29-
.. figure:: http://axelrod-python.github.io/tournament/assets/strategies_boxplot.svg
30-
:alt:
31-
32-
You can see the results from the latest run of the tournament here with
33-
the cheating strategies (which manipulate/read what the opponent does):
3+
This repository hold results for tournaments made possible by the
4+
`Axelrod-Project <https://github.com/Axelrod-Python/Axelrod>`_ python library.
345

35-
.. figure:: http://axelrod-python.github.io/tournament/assets/all_strategies_boxplot.svg
36-
:alt:
6+
Reproducing these results:
7+
==========================
378

38-
Also the pairwise performance of each strategy versus all others:
9+
To reproduce these results you will need to install the :code:`axelrod`
10+
library::
3911

40-
.. figure:: http://axelrod-python.github.io/tournament/assets/strategies_payoff.svg
41-
:alt:
42-
43-
Please do contribute :)
44-
45-
Note that you can run ``python run_axelrod -h`` for further
46-
options available: for example, cheating strategies can be excluded for
47-
faster results by running:
48-
49-
::
50-
51-
$ python run_axelrod --xc --xa
52-
53-
You can also run the tournament in parallel (below will run 4 parallel
54-
processes):
55-
56-
::
57-
58-
$ python run_axelrod -p 4
59-
60-
You can run with all available CPUs with:
61-
62-
::
63-
64-
$ python run_axelrod -p 0
12+
$ pip install axelrod
6513

6614
To re run the full set of results and output them to the `assets` directory
6715
simply run::
@@ -88,3 +36,6 @@ to the latest version of master::
8836
or::
8937

9038
$ pip install path_to_axelrod -U
39+
40+
.. |Join the chat at https://gitter.im/Axelrod-Python/Axelrod| image:: https://badges.gitter.im/Join%20Chat.svg
41+
:target: https://gitter.im/Axelrod-Python/Axelrod?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

0 commit comments

Comments
 (0)