Skip to content

Commit 28d5dd0

Browse files
committed
Fix up a number of small sections in the README.
Adds The Core and gamereplays.org to our users. Improve the section on Testing. Actively tell people not to use PyPi for now because I don't update it. Give a little extra thanks to ggtracker.
1 parent 82a96de commit 28d5dd0

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.rst

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ Our goal is to give anyone and everyone the power to construct their own
1010
tools, do their own analysis, and hack on their own Starcraft II projects
1111
under the open MIT license. Currently powering:
1212

13-
* Websites: `ggtracker.com`_
13+
* Websites: `ggtracker.com`_, `gamereplays.org`_
14+
* Tools: `The Core`_
1415
* Research: `Build Order Classification`
1516

1617
Our secondary goal is to become a reference implementation for people looking
@@ -157,24 +158,9 @@ Organizing your 1v1 replays by race played and matchup and sortable by length::
157158
Installation
158159
================
159160

160-
From PyPI (stable)
161-
---------------------
162-
163-
Install from the latest release on PyPI with pip::
164-
165-
pip install sc2reader
166-
167-
or easy_install::
168-
169-
easy_install sc2reader
170-
171-
or with setuptools (specify a valid x.x.x)::
172-
173-
wget http://pypi.python.org/packages/source/s/sc2reader/sc2reader-x.x.x.tar.gz
174-
tar -xzf sc2reader-x.x.x.tar.gz
175-
cd sc2reader-x.x.x
176-
python setup.py install
161+
Installation from PyPi is not longer recommended because I am terrible at making releases.
177162

163+
For now, just assume that I am keeping the master branch on Github stable. Sorry!
178164

179165
From Github
180166
--------------------------
@@ -204,16 +190,23 @@ are available to external modules automatically::
204190
cd sc2reader
205191
python setup.py develop
206192

207-
Contributions can be sent via pull request or by `mailing list`_ with attached
208-
patch files. It is highly recommended you get in touch with us before working
209-
on patches.
193+
Please review the CONTRIBUTING.md file and get in touch with us before doing
194+
too much work. It'll make everyone happier in the long run.
210195

211196

212197
Testing
213198
-------------------
214199

215-
mkdir testcache
216-
GGFACTORY_CACHE_DIR=testcache py.test
200+
We use py.test for testing. You can install it via pip/easy_install.
201+
202+
To run the tests just use::
203+
204+
py.test # Runs all the tests
205+
py.test test_replays # Only run tests on replays
206+
py.test test_s2gs # Only run tests on summary files
207+
208+
When repeatedly running tests it can be very helpful to make sure you've
209+
set a local cache directory to prevent long fetch times from battle.net.
217210

218211

219212
Community
@@ -245,8 +238,14 @@ and kept this project going. Special thanks to the people of the awesome
245238
starting this library possible and to sc2replay-csharp for setting us
246239
straight on game events parsing and assisting with our v1.5 upgrade.
247240

241+
I'd also like to thank ggtracker sponsoring furthered development and for
242+
providing the thousands of test files used while adding s2gs and HotS Beta
243+
support.
244+
248245
.. _Build Order Classification: https://github.com/grahamjenson/sc2reader
249246
.. _ggtracker.com: http://ggtracker.com
247+
.. _gamereplays.org: http://www.gamereplays.org/starcraft2/
248+
.. _The Core: http://www.teamliquid.net/forum/viewmessage.php?topic_id=341878
250249
.. _PyPy: http://pypy.org/
251250
.. _sc2pp: https://github.com/zsol/sc2pp
252251
.. _sc2replay-csharp: https://github.com/ascendedguard/sc2replay-csharp

0 commit comments

Comments
 (0)