From 6849c9456f4c2552829b81bec2f3198867b09e81 Mon Sep 17 00:00:00 2001 From: PJ Dietz Date: Tue, 13 Mar 2018 14:32:01 -0400 Subject: [PATCH] Add local dev info to the README --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 25306c1..7ece1b9 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,41 @@ $server->add($router); $server->respond(); ``` +Development +----------- + +Use Docker to run unit tests, manage Composer dependencies, and render a preview of the documentation site. + +To get started, run: + +```bash +docker-compose build +docker-compose run --rm php composer install +``` + +To run PHPUnit tests, use the `php` service: + +```bash +docker-compose run --rm php phpunit +``` + +To generate documentation, use the `docs` service: + +```bash +# Generate +docker-compose run --rm docs +# Clean +docker-compose run --rm docs make clean -C docs +``` + +To run a local playground site, use: + +```bash +docker-compose up -d +``` + +The runs a site you can access at [http://localhost:8080](http://localhost:8080). You can use this site to browser the [documentation](http://localhost:8080/docs/) or [code coverage report](http://localhost:8080/coverage/). + Copyright and License --------------------- Copyright © 2018 by PJ Dietz