From 7a8f7f45827aa922183e1377c498997a77281ea0 Mon Sep 17 00:00:00 2001 From: Rasmus Schultz Date: Tue, 28 May 2024 16:05:49 +0200 Subject: [PATCH] some docs --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 81b9202..6e65def 100644 --- a/README.md +++ b/README.md @@ -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