diff --git a/README.md b/README.md index 824ff45..7217e88 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,22 @@ ![The plugin UI](support/images/screenshot.png) +## Configure Appveyor ## +- Authorize access for Appveyor to your GitHub profile and add the plugin project +- Create a GitHub access token with a name like "Appveyor token for deployment" and select only `public_repo` +- Encrypt the token using [this form][95921ad4] +- Replace the content of `deploy.auth_token.secure` in `.appveyor.yml` with the encrypted string generated by the form + +## Configure Travis CI ## +- Authorize access for Travis CI to your GitHub profile and add the plugin project +- Create a GitHub access token with a name like "Travis CI token for deployment" and select only `public_repo` +- Encrypt the token using the [command line utility][feb7d597] +- Replace the content of `deploy.api_key.secure` in `.travis.yml` with the encrypted string generated by the utility + +## Triggering a release ## +- The creation of a new release on GitHub will trigger new builds (and automatic deployments) on Appveyor and Travis CI +- As an alternative, you can manually add a tag to the `master` branch: `git tag vX.Y.Z` and then push it `git push --tags` + ## Building on OS X ## - Make sure cmake, git and Xcode are installed (if not, the first two can be installed via [brew][dbaaa0fa], while Xcode can be downloaded from the App Store) - From the terminal, run: @@ -32,4 +48,6 @@ - `build/Release/gain.dll` - `build/Release/gain-vst3.dll` + [95921ad4]: https://ci.appveyor.com/tools/encrypt "Encrypt access token" + [feb7d597]: http://docs.travis-ci.com/user/encryption-keys "How to encrypt strings for Travis CI" [dbaaa0fa]: https://brew.sh "Install brew"