Skip to content

Commit bce84b6

Browse files
committed
Updated the readme
1 parent d6abf0d commit bce84b6

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,23 @@ It only documents classes and interfaces.
1313
The code is ugly, it was intended as a one-off, and I was in a hurry.. so the
1414
codebase may not be up to your standards. (it certainly isn't up to mine).
1515

16-
**Usage:**
16+
Usage
17+
-----
1718

18-
You must have phpdocumentor2 installed.
19+
# You must have phpdocumentor2 installed.
20+
# First generate a structure.xml file with phpdocumentor.
21+
# This command will generate structure.xml in the current directory.
22+
phpdoc parse -t . -d [project path]
1923

20-
First generate a `structure.xml` file as such:
24+
# Next, run phpdocmd:
25+
{$argv[0]} structure.xml [outputdir]
2126

22-
```
23-
phpdoc parse -t . -d [project path]
24-
```
27+
Options
28+
-------
2529

26-
This will create the xml file in the current directory.
27-
Next, call the phpdocmd script:
28-
29-
```
30-
phpdocmd structure.xml [outputdir]
31-
```
30+
--lt [template]
31+
This specifies the 'template' for links we're generating. By default
32+
this is "%c.md".
3233

3334
This should generate all the .md files. I'm excited to hear your feedback.
3435

0 commit comments

Comments
 (0)