Skip to content
Newer
Older
100644 35 lines (21 sloc) 957 Bytes
f1f60c1 @daleharvey fresh import, killed history on last repo
authored Jun 29, 2010
1 Erldocs
2 =======
3
b1c1640 @dreverri Updated README
dreverri authored Nov 27, 2010
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 Jun 29, 2010
5
b1c1640 @dreverri Updated README
dreverri authored Nov 28, 2010
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 Feb 3, 2011
14 git clone git://github.com/daleharvey/erldocs.git
acdf113 @dreverri Fixing README
dreverri authored Nov 27, 2010
15 cd erldocs
56f67fa @johannesh Typo and `rebar get-deps` missing from the README
johannesh authored Dec 12, 2011
16 ./rebar get-deps
acdf113 @dreverri Fixing README
dreverri authored Nov 28, 2010
17 make
b1c1640 @dreverri Updated README
dreverri authored Nov 28, 2010
18
806a618 fixed markdown
Dale Harvey authored Feb 3, 2011
19 or download [https://github.com/daleharvey/erldocs/raw/master/erldocs](https://github.com/daleharvey/erldocs/raw/master/erldocs) and place it in your $PATH
098b65a added binary and updated instructions to download
Dale Harvey authored Feb 4, 2011
20
b1c1640 @dreverri Updated README
dreverri authored Nov 28, 2010
21 Usage
22 =====
23
56f67fa @johannesh Typo and `rebar get-deps` missing from the README
johannesh authored Dec 12, 2011
24 Calling the erldocs script with no arguments will generate documentation for the application in the current working directory. The documentation will be output to "doc/erldocs".
f1f60c1 @daleharvey fresh import, killed history on last repo
authored Jun 29, 2010
25
26 `./erldocs`
b1c1640 @dreverri Updated README
dreverri authored Nov 28, 2010
27
ff48a27 @daleharvey Updated README for new -o flag
authored Nov 27, 2011
28 Additional arguments can specify the location to source files to be documented
b1c1640 @dreverri Updated README
dreverri authored Nov 28, 2010
29
ff48a27 @daleharvey Updated README for new -o flag
authored Nov 27, 2011
30 `./erldocs path/to/erlang/otp/lib/* path/to/erlang/erts`
b1c1640 @dreverri Updated README
dreverri authored Nov 28, 2010
31
ff48a27 @daleharvey Updated README for new -o flag
authored Nov 27, 2011
32 You can specify the output directory with the `-o` flag
b1c1640 @dreverri Updated README
dreverri authored Nov 28, 2010
33
ff48a27 @daleharvey Updated README for new -o flag
authored Nov 27, 2011
34 `./erldocs -o path/to/output path/to/erlang/otp/lib/* path/to/erlang/erts`
Something went wrong with that request. Please try again.