From 508cd3c220abeab3ec9e3e024798aee686d346e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Mon, 23 Mar 2015 10:18:11 +0100 Subject: [PATCH] doc: clarify that we don't maintain external doc resources PR-URL: https://github.com/libuv/libuv/pull/284 Reviewed-By: Ben Noordhuis --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ad5dddce..dd9cb15a 100644 --- a/README.md +++ b/README.md @@ -72,19 +72,23 @@ NOTE: Windows users need to use make.bat instead of plain 'make'. Documentation can be browsed online [here](http://docs.libuv.org). +The [tests and benchmarks](https://github.com/libuv/libuv/tree/master/test) +also serve as API specification and usage examples. + ### 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) — High-level introductory talk about libuv. - * [Tests and benchmarks](https://github.com/libuv/libuv/tree/master/test) - — API specification and usage examples. * [libuv-dox](https://github.com/thlorenz/libuv-dox) — Documenting types and methods of libuv, mostly by reading uv.h. * [learnuv](https://github.com/thlorenz/learnuv) — Learn uv for fun and profit, a self guided workshop to libuv. +These resources are not handled by libuv maintainers and might be out of +date. Please verify it before opening new issues. + ## Build Instructions For GCC there are two build methods: via autotools or via [GYP][].