Skip to content

Commit fa21b61

Browse files
authored
Update README.md
1 parent 7e04910 commit fa21b61

File tree

1 file changed

+5
-21
lines changed

1 file changed

+5
-21
lines changed

README.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,33 +13,17 @@ These instructions will get you a copy of the project up and running on your loc
1313

1414
### Installing
1515

16-
1. Clone the repo
17-
18-
```bash
19-
git clone https://github.com/lluiscamino/phpDoc2pdf.git
20-
```
21-
22-
2. Go into the ``phpDoc2pdf`` folder
23-
24-
```bash
25-
cd phpDoc2pdf
26-
```
27-
28-
3. Install [composer](https://github.com/composer/composer) dependencies
29-
30-
```bash
31-
php composer.phar install
32-
```
16+
1. Download the PHAR file directly from [here](https://github.com/lluiscamino/phpDoc2pdf/releases).
3317

3418
### Usage
3519

36-
Go into the ``src/application`` directory and run this command:
20+
Use the following command to generate the documentation:
3721

3822
```bash
39-
php createDocs.php create INPUT OUTPUT
23+
php phpDoc2pdf.phar create <INPUT> <OUTPUT>
4024
```
4125

42-
Replace ``INPUT`` with the PHP file or directory that you want to document and ``OUTPUT`` with the directory where documentation will be generated.
26+
Replace ``<INPUT>`` with the PHP file or directory that you want to document and ``<OUTPUT>`` with the directory where the documentation will be saved.
4327

4428
## Built With
4529

@@ -60,7 +44,7 @@ All contributions are welcome, please see the To-do list below or suggest someth
6044
- [x] Add markdown support
6145
- [x] Add templates system
6246
- [ ] Separate generated docs into different subdirectories
63-
- [ ] Make installation and usage simpler
47+
- [x] Make installation and usage simpler
6448
- [ ] Include phpDocBlock types on method arguments
6549

6650
## License

0 commit comments

Comments
 (0)