ext/libuv/README.md in uvrb-0.1.4 vs ext/libuv/README.md in uvrb-0.2.0

- old
+ new

@@ -1,13 +1,11 @@ # libuv -libuv is a new platform layer for Node. Its purpose is to abstract IOCP on -Windows and epoll/kqueue/event ports/etc. on Unix systems. We intend to +libuv is a platform layer for [node.js][]. Its purpose is to abstract IOCP +on Windows and epoll/kqueue/event ports/etc. on Unix systems. We intend to eventually contain all platform differences in this library. -http://nodejs.org/ - ## Features * Non-blocking TCP sockets * Non-blocking named pipes @@ -28,13 +26,12 @@ * Thread pool scheduling `uv_queue_work` * ANSI escape code controlled TTY `uv_tty_t` - * File system events Currently supports inotify, `ReadDirectoryChangesW` - and kqueue. Event ports in the near future. - `uv_fs_event_t` + * File system events using inotify, kqueue, event ports, + FSEvents and `ReadDirectoryChangesW` * IPC and socket sharing between processes `uv_write2` ## Community @@ -51,68 +48,65 @@ * [Tests and benchmarks](https://github.com/joyent/libuv/tree/master/test) - API specification and usage examples. ## Build Instructions -For GCC (including MinGW) there are two methods building: via normal -makefiles or via GYP. GYP is a meta-build system which can generate MSVS, -Makefile, and XCode backends. It is best used for integration into other -projects. The old system is using plain GNU Makefiles. +For GCC there are two methods building: via autotools or via [GYP][]. +GYP is a meta-build system which can generate MSVS, Makefile, and XCode +backends. It is best used for integration into other projects. -To build via Makefile simply execute: +To build with autotools: - make + $ sh autogen.sh + $ ./configure + $ make + $ make check + $ make install -MinGW users should run this instead: - - make PLATFORM=mingw - -Out-of-tree builds are supported: - - make builddir_name=/path/to/builddir - To build with Visual Studio run the vcbuild.bat file which will checkout the GYP code into build/gyp and generate the uv.sln and related files. -Windows users can also build from cmd-line using msbuild. This is -done by running vcbuild.bat from Visual Studio command prompt. +Windows users can also build from the command line using msbuild. +This is done by running vcbuild.bat from Visual Studio command prompt. To have GYP generate build script for another system, make sure that you have Python 2.6 or 2.7 installed, then checkout GYP into the project tree manually: - mkdir -p build - svn co http://gyp.googlecode.com/svn/trunk build/gyp + $ mkdir -p build + $ git clone https://git.chromium.org/external/gyp.git build/gyp -Or: +Unix users run: - mkdir -p build - git clone https://git.chromium.org/external/gyp.git build/gyp + $ ./gyp_uv -f make + $ make -C out -Unix users run +Macintosh users run: - ./gyp_uv -f make - make -C out + $ ./gyp_uv -f xcode + $ xcodebuild -project uv.xcodeproj -configuration Release -target All -Macintosh users run +To build for android: - ./gyp_uv -f xcode - xcodebuild -project uv.xcodeproj -configuration Release -target All + $ source ./android-configure NDK_PATH gyp + $ make -C out Note for UNIX users: compile your project with `-D_LARGEFILE_SOURCE` and `-D_FILE_OFFSET_BITS=64`. GYP builds take care of that automatically. -Note for Linux users: compile your project with `-D_GNU_SOURCE` when you -include `uv.h`. GYP builds take care of that automatically. If you use -autotools, add a `AC_GNU_SOURCE` declaration to your `configure.ac`. - ## Supported Platforms Microsoft Windows operating systems since Windows XP SP2. It can be built -with either Visual Studio or MinGW. +with either Visual Studio or MinGW. Consider using +[Visual Studio Express 2010][] or later if you do not have a full Visual +Studio license. -Linux 2.6 using the GCC toolchain. +Linux using the GCC toolchain. MacOS using the GCC or XCode toolchain. Solaris 121 and later using GCC toolchain. + +[node.js]: http://nodejs.org/ +[GYP]: http://code.google.com/p/gyp/ +[Visual Studio Express 2010]: http://www.microsoft.com/visualstudio/eng/products/visual-studio-2010-express