Browse Source

rebuilt documentation

Ulf Wiger 9 years ago
parent
commit
4824309eb9
4 changed files with 54 additions and 3 deletions
  1. 26 0
      README.md
  2. 26 0
      doc/README.md
  3. 0 1
      doc/edoc-info
  4. 2 2
      doc/stylesheet.css

+ 26 - 0
README.md

@@ -22,6 +22,13 @@ actively use either, they are no longer fetched by default.
 
 
 
 
 
 
+## Installation ##
+
+You can get `gproc` from the [Hex package manager](https://hex.pm/packages/gproc)
+
+That means declaring dependency on `{gproc, "0.5.0"}` in your `rebar3`-based applications or `{:gproc, "~> 0.5.0"}` in your `mix` based applications.
+
+
 ## Introduction ##
 ## Introduction ##
 
 
 Gproc is a process dictionary for Erlang, which provides a number of useful features beyond what the built-in dictionary has:
 Gproc is a process dictionary for Erlang, which provides a number of useful features beyond what the built-in dictionary has:
@@ -102,3 +109,22 @@ If you want to change this, remove the `edoc_opts` line from `rebar.config`.
 
 
 Gproc was first introduced at the ACM SIGPLAN Erlang Workshop in
 Gproc was first introduced at the ACM SIGPLAN Erlang Workshop in
 Freiburg 2007 ([Paper available here](http://github.com/uwiger/gproc/blob/master/doc/erlang07-wiger.pdf)).
 Freiburg 2007 ([Paper available here](http://github.com/uwiger/gproc/blob/master/doc/erlang07-wiger.pdf)).
+
+
+## Modules ##
+
+
+<table width="100%" border="0" summary="list of modules">
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc.md" class="module">gproc</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_app.md" class="module">gproc_app</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_bcast.md" class="module">gproc_bcast</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_dist.md" class="module">gproc_dist</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_info.md" class="module">gproc_info</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_init.md" class="module">gproc_init</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_lib.md" class="module">gproc_lib</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_monitor.md" class="module">gproc_monitor</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_pool.md" class="module">gproc_pool</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_ps.md" class="module">gproc_ps</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_pt.md" class="module">gproc_pt</a></td></tr>
+<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_sup.md" class="module">gproc_sup</a></td></tr></table>
+

+ 26 - 0
doc/README.md

@@ -22,6 +22,13 @@ actively use either, they are no longer fetched by default.
 
 
 
 
 
 
+## Installation ##
+
+You can get `gproc` from the [Hex package manager](https://hex.pm/packages/gproc)
+
+That means declaring dependency on `{gproc, "0.5.0"}` in your `rebar3`-based applications or `{:gproc, "~> 0.5.0"}` in your `mix` based applications.
+
+
 ## Introduction ##
 ## Introduction ##
 
 
 Gproc is a process dictionary for Erlang, which provides a number of useful features beyond what the built-in dictionary has:
 Gproc is a process dictionary for Erlang, which provides a number of useful features beyond what the built-in dictionary has:
@@ -102,3 +109,22 @@ If you want to change this, remove the `edoc_opts` line from `rebar.config`.
 
 
 Gproc was first introduced at the ACM SIGPLAN Erlang Workshop in
 Gproc was first introduced at the ACM SIGPLAN Erlang Workshop in
 Freiburg 2007 ([Paper available here](erlang07-wiger.pdf)).
 Freiburg 2007 ([Paper available here](erlang07-wiger.pdf)).
+
+
+## Modules ##
+
+
+<table width="100%" border="0" summary="list of modules">
+<tr><td><a href="gproc.md" class="module">gproc</a></td></tr>
+<tr><td><a href="gproc_app.md" class="module">gproc_app</a></td></tr>
+<tr><td><a href="gproc_bcast.md" class="module">gproc_bcast</a></td></tr>
+<tr><td><a href="gproc_dist.md" class="module">gproc_dist</a></td></tr>
+<tr><td><a href="gproc_info.md" class="module">gproc_info</a></td></tr>
+<tr><td><a href="gproc_init.md" class="module">gproc_init</a></td></tr>
+<tr><td><a href="gproc_lib.md" class="module">gproc_lib</a></td></tr>
+<tr><td><a href="gproc_monitor.md" class="module">gproc_monitor</a></td></tr>
+<tr><td><a href="gproc_pool.md" class="module">gproc_pool</a></td></tr>
+<tr><td><a href="gproc_ps.md" class="module">gproc_ps</a></td></tr>
+<tr><td><a href="gproc_pt.md" class="module">gproc_pt</a></td></tr>
+<tr><td><a href="gproc_sup.md" class="module">gproc_sup</a></td></tr></table>
+

+ 0 - 1
doc/edoc-info

@@ -1,5 +1,4 @@
 %% encoding: UTF-8
 %% encoding: UTF-8
 {application,gproc}.
 {application,gproc}.
-{packages,[]}.
 {modules,[gproc,gproc_app,gproc_bcast,gproc_dist,gproc_info,gproc_init,
 {modules,[gproc,gproc_app,gproc_bcast,gproc_dist,gproc_info,gproc_init,
           gproc_lib,gproc_monitor,gproc_pool,gproc_ps,gproc_pt,gproc_sup]}.
           gproc_lib,gproc_monitor,gproc_pool,gproc_ps,gproc_pt,gproc_sup]}.

+ 2 - 2
doc/stylesheet.css

@@ -27,10 +27,10 @@ div.spec {
  	margin-left: 2em;
  	margin-left: 2em;
 	background-color: #eeeeee;
 	background-color: #eeeeee;
 }
 }
-a.module,a.package {
+a.module {
 	text-decoration:none
 	text-decoration:none
 }
 }
-a.module:hover,a.package:hover {
+a.module:hover {
 	background-color: #eeeeee;
 	background-color: #eeeeee;
 }
 }
 ul.definitions {
 ul.definitions {