From 078d686a0ac0aed212db97d73bd1e4a9387a4956 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sun, 6 Jul 2014 13:10:35 +0200 Subject: Provide installable man pages make docs: generate Markdown and man pages in doc/ make install-docs: install man pages to be usable directly Docs are generated from the ezdoc files in doc/src/. --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8313bc6..2919e63 100644 --- a/README.md +++ b/README.md @@ -27,15 +27,23 @@ The SPDY implementation was sponsored by The project is currently sponsored by [Kato.im](https://kato.im). -Getting Started ---------------- +Online documentation +-------------------- - * [Read the guide](http://ninenines.eu/docs/en/cowboy/HEAD/guide) - * [Check the manual](http://ninenines.eu/docs/en/cowboy/HEAD/manual) - * Look at the examples in the `examples/` directory + * [User guide](http://ninenines.eu/docs/en/cowboy/HEAD/guide) + * [Function reference](http://ninenines.eu/docs/en/cowboy/HEAD/manual) -Support -------- +Offline documentation +--------------------- + + * While still online, run `make docs` + * 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 Markdown available in `doc/markdown/` + * Examples available in `examples/` + +Getting help +------------ * Official IRC Channel: #ninenines on irc.freenode.net * [Mailing Lists](http://lists.ninenines.eu) -- cgit v1.2.3