diff --git a/README.rst b/README.rst index 317cb1d3f..1913910e8 100644 --- a/README.rst +++ b/README.rst @@ -1,15 +1,18 @@ -Pillow OS X wheel builder -========================= +Pillow Wheels for OS X +====================== -Repository to build Pillow wheels. +This repository builds the most recent tagged version of the Pillow repository. -By default, this repo builds the most recent tagged version of the Pillow repo. If you want to build a specific version, unset ``LATEST_TAG`` in the ``.travis.yml`` file, and update the Pillow submodule to the version you want to build. - -To update: - -- Update Pillow submodule with version you want to build: +Build +----- :: + git submodule init + git submodule update + git add Pillow + git commit -a -m "Build wheels" + +To build a specific version, unset ``LATEST_TAG`` in the ``.travis.yml`` file and update the Pillow submodule:: cd Pillow git pull && git checkout DESIRED_TAG @@ -17,6 +20,9 @@ To update: git add Pillow git commit -- Check minimum numpy versions to build against in ``.travis.yml`` file. You need to build against the earliest numpy that Pillow is compatible with; see `forward, backward numpy compatibility `_ +Notes +----- -The wheels get uploaded to a `rackspace container `_. The credentials for this container are encrypted to this specific repo in the ``.travis.yml`` file, so the upload won't work for you from another repo. +- Check minimum numpy versions to build against in ``.travis.yml`` file. Build against the earliest numpy that Pillow is compatible with; see `forward, backward numpy compatibility `_ + +- Wheels are uploaded to a `rackspace container `_. Credentials for this container are encrypted to this specific repo in the ``.travis.yml`` file so the upload won't work from another repository.