Improve README

This commit is contained in:
Vincent Letourneau
2017-01-23 11:52:14 +01:00
parent 0c081d7fc9
commit d0595e1a88

View File

@@ -38,7 +38,7 @@ Docker running Nginx, PHP-FPM, MySQL and PHPMyAdmin.
## Directory tree ## Directory tree
```sh ```sh
docker-nginx-php-mysql ├── README.md
├── bin ├── bin
│   └── linux │   └── linux
│   └── clean.sh │   └── clean.sh
@@ -56,8 +56,12 @@ docker-nginx-php-mysql
└── web └── web
├── app ├── app
│   ├── composer.json │   ├── composer.json
│   ├── phpunit.xml.dist
│   ├── src │   ├── src
│   └── tests │   │   └── Foo.php
│   └── test
│   ├── FooTest.php
│   └── bootstrap.php
└── public └── public
└── index.php └── 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 ## Cleaning project
```sh ```sh