diff options
| author | Loïc Hoguin <[email protected]> | 2018-09-10 16:45:22 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2018-09-10 16:45:22 +0200 |
| commit | 0dd581dbf801306f27f00bc73f04da003cd65039 (patch) | |
| tree | 5224c432f413684d1208a9cf29ac40e6736b8109 /README.asciidoc | |
| parent | f3149399815257b934ca5c47c9b9f2d9de198bc6 (diff) | |
| download | gun-0dd581dbf801306f27f00bc73f04da003cd65039.tar.gz gun-0dd581dbf801306f27f00bc73f04da003cd65039.tar.bz2 gun-0dd581dbf801306f27f00bc73f04da003cd65039.zip | |
Add more details to the README
Diffstat (limited to 'README.asciidoc')
| -rw-r--r-- | README.asciidoc | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/README.asciidoc b/README.asciidoc index 4ce562b..7400912 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -22,7 +22,21 @@ https://kato.im[Kato.im] and https://sameroom.io[Sameroom]. The now removed SPDY implementation was sponsored by http://www.leofs.org[LeoFS Cloud Storage]. +== Online documentation + +* https://ninenines.eu/docs/en/gun/1.1/guide[User guide] +* https://ninenines.eu/docs/en/gun/1.1/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/` + == Getting help * Official IRC Channel: #ninenines on irc.freenode.net +* https://github.com/ninenines/gun/issues[Issues tracker] * https://ninenines.eu/services/[Commercial Support] |