diff options
| author | Loïc Hoguin <[email protected]> | 2014-07-06 13:10:35 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2014-07-06 13:10:35 +0200 |
| commit | 078d686a0ac0aed212db97d73bd1e4a9387a4956 (patch) | |
| tree | 6bbc6111fdbdfedd3bb351bf3b01c63fac0d7143 /README.md | |
| parent | 1a71a733c37df70c15ebfd28157b10915cd738d1 (diff) | |
| download | cowboy-078d686a0ac0aed212db97d73bd1e4a9387a4956.tar.gz cowboy-078d686a0ac0aed212db97d73bd1e4a9387a4956.tar.bz2 cowboy-078d686a0ac0aed212db97d73bd1e4a9387a4956.zip | |
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/.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 15 insertions, 7 deletions
@@ -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) |