Skip to content

Commit 83ff11c

Browse files
committed
Adding details to readme:
- Changing image formats (png -> svg) - Including some instructions about setting up a virtualenv to have the up to date version of axelrod without messing with system installs etc...
1 parent c241d7d commit 83ff11c

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
env

README.rst

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ tournament. To run the tournament, you simply need to:
2323

2424
$ python run_axelrod
2525

26-
This automatically outputs a ``png`` file with the results. You can see
26+
This automatically outputs a ``svg`` file with the results. You can see
2727
the results from the latest run of the tournament here:
2828

2929
.. figure:: http://axelrod-python.github.io/tournament/assets/strategies_boxplot.svg
@@ -62,3 +62,29 @@ You can run with all available CPUs with:
6262
::
6363

6464
$ python run_axelrod -p 0
65+
66+
To re run the full set of results and output them to the `assets` directory
67+
simply run::
68+
69+
$ ./update_results.sh
70+
71+
**Note that this uses the installed version of the axelrod library.**
72+
If you want to keep things tidy you can create a virtualenv and install the
73+
latest version of the library like so::
74+
75+
$ virtualenv env
76+
$ source env/bin/activate
77+
$ pip install git+https://github.com/Axelrod-Python/Axelrod@master
78+
79+
If you have the Axelrod repository locally you can also run::
80+
81+
$ pip install path_to_axelrod
82+
83+
If you have already installed :code:`axelrod` you can add the `-U` tag to update
84+
to the latest version of master::
85+
86+
$ pip install git+https://github.com/Axelrod-Python/Axelrod@master -U
87+
88+
or::
89+
90+
$ pip install path_to_axelrod -U

0 commit comments

Comments
 (0)