From d0595e1a88f2f2c35d175e4eb1075760cd71af5e Mon Sep 17 00:00:00 2001 From: Vincent Letourneau Date: Mon, 23 Jan 2017 11:52:14 +0100 Subject: [PATCH] Improve README --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1fd19a8..3cd09c4 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Docker running Nginx, PHP-FPM, MySQL and PHPMyAdmin. ## Directory tree ```sh -docker-nginx-php-mysql +├── README.md ├── bin │   └── linux │   └── clean.sh @@ -56,8 +56,12 @@ docker-nginx-php-mysql └── web ├── app │   ├── composer.json + │   ├── phpunit.xml.dist │   ├── src - │   └── tests + │   │   └── Foo.php + │   └── test + │   ├── FooTest.php + │   └── bootstrap.php └── public └── index.php ``` @@ -125,6 +129,12 @@ $ docker exec mysql sh -c 'exec mysqldump test -uroot -p"$MYSQL_ROOT_PASSWORD"' # } ``` +## Generating API Documentation + +```sh +./web/app/vendor/apigen/apigen/bin/apigen generate -s web/app/src -d web/app/doc +``` + ## Cleaning project ```sh