Skip to content

Commit 176cfe3

Browse files
committed
Update raml2html's README.md
1 parent de8655c commit 176cfe3

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

tools/raml2html/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,20 @@ Tool for generating static HTML from RAML definitions.
44

55
## Installation
66

7-
Install required dependencies before use. Go to raml2html root directory and run:
7+
PHP 7.2 and [Composer](https://getcomposer.org/) are required.
88

9-
```
10-
composer install
9+
To install required dependencies, go to raml2html directory and run:
10+
11+
```sh
12+
composer install;
1113
```
1214

13-
To generate static HTML from RAML definitions, use the following code:
15+
## Usage
1416

17+
To generate static HTML from RAML definitions, use the following code from project root:
1518

1619
```sh
1720
php tools/raml2html/raml2html.php build --non-standard-http-methods=COPY,MOVE,PUBLISH,SWAP -t default -o docs/api/rest_api_reference/output/ docs/api/rest_api_reference/input/ez.raml
1821
```
22+
23+
Note: If PHP 7.2 is not the default PHP, please, adapt.

0 commit comments

Comments
 (0)