Commit 532951a1 by William Tisäter

Update README files

parent 1bafc985
......@@ -2,6 +2,7 @@
### Release 0.3.1
* New: Documentation now available on readthedocs.org
* New: MaxMind Netspeed database support
* Fix: Release thread lock on exceptions
......
......@@ -16,15 +16,10 @@ https://www.defunct.cc/maxmind-geoip-samples.tar.gz (17 MB)
Extract the tarball in the tests directory and run `tox` from the root directory.
This requires a machine with Python 2.5 - 3.3 installed and all dependencies mention in the header.
### Documentation
For converting Markdown to reStructuredText used by PyPi we use pandoc.
[Read pandoc's install instructions](http://johnmacfarlane.net/pandoc/installing.html).
This requires a machine with Python 2.6 - 3.3 installed and all dependencies mention in the header.
### TL;DR
There's a shell script doing all this for you.
There's a Makefile doing all this for you.
./build.sh
make test
.PHONY: docs
all: test docs
all: test
test:
@echo "Downloading test databases"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment