From 95797f48e8351d487f49d4c11a7d9585fd32bb6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Sat, 6 Sep 2014 21:46:23 +0200 Subject: [PATCH] doc: mention API documentation in README --- README.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 032c43ca..e0edf503 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ used by Mozilla's [Rust language](http://www.rust-lang.org/), Starting with version 1.0.0 libuv follows the [semantic versioning](http://semver.org/) scheme. The API change and backwards compatiblity rules are those indicated by -SemVer. libuv will keel a stable ABI across major releases. +SemVer. libuv will keep a stable ABI across major releases. ## Community @@ -46,8 +46,34 @@ SemVer. libuv will keel a stable ABI across major releases. ## Documentation - * [include/uv.h](https://github.com/joyent/libuv/blob/master/include/uv.h) - — API documentation in the form of detailed header comments. +### Official API documentation + +Located in the docs/ subdirectory. It uses the [Sphinx](http://sphinx-doc.org/) +framework, which makes it possible to build the documentation in multiple +formats. + +Show different supported building options: + + $ make help + +Build documentation as HTML: + + $ make html + +Build documentation as man pages: + + $ make man + +Build documentation as ePub: + + $ make epub + +NOTE: Windows users need to use make.bat instead of plain 'make'. + +Documentation can be browsed online [here](http://docs.libuv.org). + +### Other resources + * [An Introduction to libuv](http://nikhilm.github.com/uvbook/) — An overview of libuv with tutorials. * [LXJS 2012 talk](http://www.youtube.com/watch?v=nGn60vDSxQ4)