From 36ebfcfc938e68f29345ea8931a788f8745f7663 Mon Sep 17 00:00:00 2001 From: Ben Ramsey Date: Sat, 26 Sep 2015 19:06:39 -0500 Subject: [PATCH] Add apigen/apigen to the dev requirements --- README.md | 6 +++--- composer.json | 3 ++- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 338dd10..69182ad 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,11 @@ Much inspiration for this library came from the [Java][javauuid] and The [latest class API documentation][apidocs] is available online. This project uses [ApiGen](http://apigen.org/) to generate this documentation. To -generate the documentation on your own, install ApiGen and run the following command -from the root of the project: +generate the documentation on your own, install dev dependencies and run the +following command from the root of the project: ``` -apigen generate --source="src" --destination="build/apidocs" --title="ramsey/uuid" --template-theme="bootstrap" --deprecated --todo +./vendor/bin/apigen generate --source="src" --destination="build/apidocs" --title="ramsey/uuid" --template-theme="bootstrap" --deprecated --todo ``` This will generate documentation in the `build/apidocs/` folder. diff --git a/composer.json b/composer.json index 3ccdf23..216d008 100644 --- a/composer.json +++ b/composer.json @@ -33,7 +33,8 @@ "phpunit/phpunit": "^4.7", "squizlabs/php_codesniffer": "^2.3", "jakub-onderka/php-parallel-lint": "^0.9.0", - "satooshi/php-coveralls": "^0.6.1" + "satooshi/php-coveralls": "^0.6.1", + "apigen/apigen": "^4.1" }, "suggest": { "ramsey/uuid-doctrine": "Allow the use of a UUID as Doctrine field type.",