diff options
| author | Loïc Hoguin <[email protected]> | 2016-11-28 12:22:16 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2016-11-28 12:23:26 +0100 |
| commit | 12790e41e41f9f49586fab9200bdda6149ee4597 (patch) | |
| tree | 3bfaf6bc1f8fa4b521f0cad98da3bdff89a0380c /README.asciidoc | |
| parent | 40809cd2b257a8a53bcb5588ecaa88cc5381ff5c (diff) | |
| download | ranch-12790e41e41f9f49586fab9200bdda6149ee4597.tar.gz ranch-12790e41e41f9f49586fab9200bdda6149ee4597.tar.bz2 ranch-12790e41e41f9f49586fab9200bdda6149ee4597.zip | |
Update README with links to issues/offline docs
Diffstat (limited to 'README.asciidoc')
| -rw-r--r-- | README.asciidoc | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/README.asciidoc b/README.asciidoc index 835a498..3e32f95 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -17,13 +17,22 @@ into **pools**, each pool having a different configurable limit. Ranch also allows you to **upgrade** the acceptor pool without having to close any of the currently opened sockets. -== Getting started +== Online documentation -* link:doc/src/guide/book.asciidoc[Read the guide] -* link:doc/src/manual/[Check the manual] -* Look at the examples in the `examples/` directory +* http://ninenines.eu/docs/en/ranch/1.3/guide[User guide] +* http://ninenines.eu/docs/en/ranch/1.3/manual[Function reference] + +== Offline documentation + +* While still online, run `make docs` +* User guide available in `doc/` in PDF and HTML formats +* Function reference man pages available in `doc/man3/` and `doc/man7/` +* Run `make install-docs` to install man pages on your system +* Full documentation in Asciidoc available in `doc/src/` +* Examples available in `examples/` == Support * Official IRC Channel: #ninenines on irc.freenode.net +* https://github.com/ninenines/ranch/issues[Issues tracker] * http://ninenines.eu/services[Commercial Support] |