aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Nicksay <nicksay@google.com>2016-10-17 13:00:14 -0400
committerAlex Nicksay <nicksay@google.com>2016-10-17 13:57:56 -0400
commitb04f4ea185a399369edb484e46a3626cb4c8c4e0 (patch)
treed853f6b14afdcad53378bfd11e52bd234180111a /README.md
parentd60aa2311664f0ac35b6ed1a10a990658eba4b86 (diff)
downloadbrotli-b04f4ea185a399369edb484e46a3626cb4c8c4e0.zip
brotli-b04f4ea185a399369edb484e46a3626cb4c8c4e0.tar.gz
brotli-b04f4ea185a399369edb484e46a3626cb4c8c4e0.tar.bz2
Python: Update README with information about code formatting
Also, add a `yapf` section to `setup.cfg` to ensure YAPF runs format code with the Google style.
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1e7225d..30ccda6 100644
--- a/README.md
+++ b/README.md
@@ -50,11 +50,13 @@ See [Premake5](https://premake.github.io/)
#### Python
-The basic commands to build, test and install the Python binding are:
+The basic commands to build, test, and install the Python module are:
$ python setup.py build_ext test
$ python setup.py install
+See the [Python readme](python/README.md) for more details.
+
### Benchmarks
* [Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/) / [Unstable Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/unstable/)
* [Large Text Compression Benchmark](http://mattmahoney.net/dc/text.html)