Skip to content

Commit 250f97e

Browse files
committed
Documenation: Rework usage section
1 parent 5dfa49b commit 250f97e

File tree

1 file changed

+16
-30
lines changed

1 file changed

+16
-30
lines changed

README.md

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,42 +29,28 @@ chmod +x ${BINDIR}/phpcc
2929
```
3030
phpcc --help
3131
phpcc --version
32-
phpcc -e <entrypoint> -o <output> [-d dir [-d dir ...]] [-f file [-f file ...]] [-b <banner>]
32+
```
33+
34+
```
35+
phpcc \
36+
-e <entrypoint> \
37+
-o <output> \
38+
[-d dir [-d dir ...]] \
39+
[-f file [-f file ...]] \
40+
[-b <banner>]
3341
```
3442

3543
### Options/Arguments
3644

3745
> The output and entrypoint scripts are mandatory.
3846
39-
#### `-e`, `--entrypoint`
40-
41-
**MANDATORY** The main application entrypoint script.
42-
43-
#### `-o`, `--output`
44-
45-
**MANDATORY** The Phar archive output file.
46-
47-
#### `-f`, `--file`
48-
49-
Adds a single file to the archive.
50-
51-
_Multiple values allowed here_
52-
53-
#### `-d`, `--dir`
54-
55-
Adds a sources directory to the archive.
56-
57-
_Multiple values allowed here_
58-
59-
> Each directory may be of the form:
60-
> - `$dir` => include all files in directory
61-
> - `$dir:$extension` => filter files on a specific extension
62-
63-
#### `-b`, `--banner`
64-
65-
Filepath to the legal notice banner.
66-
67-
_Will be included in the human-readable part of the stub._
47+
Name / Shorthand | Type | Description |Required
48+
--------------------|:-----:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------:
49+
`--output`, `-o` | value | The Phar archive output file |y
50+
`--entrypoint`, `-e`| value | The main application entrypoint script |y
51+
`--banner`, `-b` | value | Specify the filepath to the legal notice banner<br/>_Will be included in the human-readable part of the stub._ |n
52+
`--file`, `-f` | multi | Adds a single file to the archive |n
53+
`--dir`, `-d` | multi | Adds a sources directory to the archive<br/>_Possible dir spec formats:<br/>- `$dir` => include all files in directory<br/>- `$dir:$extension` => filter files on a specific extension_ |n
6854

6955

7056
### Examples

0 commit comments

Comments
 (0)