Permalink
Browse files

added words about building docs

  • Loading branch information...
1 parent bde4651 commit 1cb3c92dc2427bab3dca1d0b627d8238a8e34dd1 Ulf Wiger committed Oct 22, 2010
Showing with 7 additions and 0 deletions.
  1. +7 −0 README.md
  2. BIN doc/erlang07-wiger.doc
  3. BIN doc/erlang07-wiger.pdf
View
@@ -16,3 +16,10 @@ Gproc is a process dictionary for Erlang, which provides a number of useful feat
Gproc has a QuickCheck test suite, covering a fairly large part of the local gproc functionality, although none of the global registry. It requires a commercial EQC license, but rebar is smart enough to detect whether EQC is available, and if it isn't, the code in gproc_eqc.erl will be "defined away".
There is also an eunit suite in gproc.erl, but it covers only some of the most basic functions (local only). Lots more tests need to be written... some day. Contributions are most welcome.
+
+Building Edoc
+=============
+By default, `./rebar doc` generates Github-flavored Markdown files.
+If you want to change this, remove this line from `rebar.config`.
+
+`{edoc_opts, [{doclet, edown_doclet}]}.`
View
Binary file not shown.
View
Binary file not shown.

0 comments on commit 1cb3c92

Please sign in to comment.