# qa-tools-v3
QA-Tools v3 repo - just staging for development.

# TODO

- rewrite this README to make sense.

# qa-tools-v3
QA-Tools v3 repo - just staging for development.

# The QA-tools PHAR File
## Building the PHAR
The QA-tools are distributed as a PHP Archive (phar) file in order to separate the QA-tools' dependencies from
the host projects' dependencies.

[Box][^box] is used for building the QA-tools phar-file, which is configured in the `box.json` file.
It is included as a phar-file itself to prevent version conflicts between Box' and QA-tools' dependencies.

Run `composer build` in the project root directory to build `./dist/qa-tools.phar` and `./dist/qa-tools.phar.pubkey`.
The public key inside `./dist/qa-tools.phar.pubkey` is generated based on `.travis/phar-private.pem`,
the git-ignored key used to sign the phar-file.

[^box]: https://box-project.github.io/box2/

## Updating Box
Box is installed during Composer's `post-install-cmd` phase. 
To update Box, manually update the source and sha sum inside `composer.json` under `extra`.

Document building and updating Box
Document building and updating Box
