Skip to content

Commit

Permalink
some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mindplay-dk committed May 28, 2024
1 parent d523a96 commit 7a8f7f4
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,26 @@ the internal `protected` portion of the API; typically, a major `0.x+1` release

### Contributions

Current target is php 5.5 and later, see `.travis.yml`.
Current target is php 8.1 or later.

Code adheres to [PSR-2](http://www.php-fig.org/psr/psr-2/) and [PSR-4](http://www.php-fig.org/psr/psr-4/).

To run the test-suite:
You need a working [Docker](https://docs.docker.com/get-docker/) installation to run the tests.

php test/test.php
To launch Docker and run the test-suite, e.g. in PHP `8.3`:

To run only the unit or integration suites:
./test.sh 8.3

php test/test.php --unit
php test/test.php --integration
Once the Docker environment is running, you can run the tests more quickly on the existing Docker environment:

./test.sh

Once running, if you prefer, you can also just shell into the PHP container and run the tests from there, for example:

docker compose exec php sh
composer update
composer test
exit

## Overview

Expand Down

0 comments on commit 7a8f7f4

Please sign in to comment.