Skip to content
Newer
Older
100644 42 lines (24 sloc) 1 KB
f1f60c1 @daleharvey fresh import, killed history on last repo
authored
1 Erldocs
2 =======
3
b1c1640 @dreverri Updated README
dreverri authored
4 This is the code used to generate documentation for erlang projects in the format of [erldocs.com](http://erldocs.com)
f1f60c1 @daleharvey fresh import, killed history on last repo
authored
5
b1c1640 @dreverri Updated README
dreverri authored
6 Dependencies
7 ============
8
9 Erlang R13B04 or greater
10
11 Building
12 ========
13
098b65a added binary and updated instructions to download
Dale Harvey authored
14 git clone git://github.com/daleharvey/erldocs.git
acdf113 @dreverri Fixing README
dreverri authored
15 cd erldocs
16 make
b1c1640 @dreverri Updated README
dreverri authored
17
098b65a added binary and updated instructions to download
Dale Harvey authored
18 or download
19
20 https://github.com/daleharvey/erldocs/raw/master/rebar
21
22 and place it in your $PATH
23
b1c1640 @dreverri Updated README
dreverri authored
24 Usage
25 =====
26
27 Calling the erldocs script with no arguments will generate documentation for the application in the current working. The documentation will be output to "doc/erldocs".
f1f60c1 @daleharvey fresh import, killed history on last repo
authored
28
29 `./erldocs`
b1c1640 @dreverri Updated README
dreverri authored
30
31 Calling erldocs with one argument will changes the output directory to the one specified in the argument.
32
33 `./erldocs docs/alternate_location`
34
35 Calling erldocs with multiple arguments changes both the destination of the generated documentation and the source of the documentation.
36
37 `./erldocs path/to/erlang/otp/lib/edoc doc/edoc_docs`
38
39 Source arguments can use wildcards.
40
41 `./erldocs path/to/erlang/otp/lib/* doc/otp_docs`
Something went wrong with that request. Please try again.