Commit Graph

70 Commits

Author SHA1 Message Date
Jamie Davis
f60713f7cf
doc: README: add note on installing gyp
Problem:
The instructions assume you have already installed gyp to
build/gyp.

If you run 'make' without doing so, it asks you to read the README,
which does not actually tell you about installing gyp.

Solution:
Add a one-liner `git clone` command to the setup instructions.

PR-URL: https://github.com/libuv/libuv/pull/1712
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2018-02-28 22:29:00 +01:00
Saúl Ibarra Corretgé
cf6d047e84 doc: update instructions for building on Android
PR-URL: https://github.com/libuv/libuv/pull/1441
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2017-07-27 00:46:02 +02:00
Refael Ackermann
80d3b95f57 doc: format README
PR-URL: https://github.com/libuv/libuv/pull/1284
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2017-07-04 22:40:14 +02:00
Refael Ackermann
0953bf0dad doc: add instructions for building on Windows
PR-URL: https://github.com/libuv/libuv/pull/1284
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2017-07-04 22:38:27 +02:00
Saúl Ibarra Corretgé
2ce5734d76 doc: remove ubvook reference from README
PR-URL: https://github.com/libuv/libuv/pull/1246
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2017-04-28 11:16:09 +02:00
Saúl Ibarra Corretgé
ed76c055cd doc: change license to CC BY 4.0
Text taken from:
https://creativecommons.org/licenses/by/4.0/legalcode.txt

Fixes: https://github.com/libuv/libuv/issues/1254
PR-URL: https://github.com/libuv/libuv/pull/1246
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2017-04-28 11:15:59 +02:00
Ben Noordhuis
8fd1e40606 doc: add link to libuv/help to README
PR-URL: https://github.com/libuv/libuv/pull/1309
Refs: https://github.com/libuv/libuv/issues/1305
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2017-04-18 17:30:04 +02:00
Saúl Ibarra Corretgé
79e80e0f12 doc: add ABI tracker link to README
PR-URL: https://github.com/libuv/libuv/pull/1053
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Fedor Indutny <fedor@indutny.com>
2016-09-18 10:10:24 +02:00
Saúl Ibarra Corretgé
be0e24c1e8 doc: add supported platforms description
Closes: https://github.com/libuv/libuv/issues/983
PR-URL: https://github.com/libuv/libuv/pull/991
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-08-12 22:48:06 +01:00
Saúl Ibarra Corretgé
8b3176933d doc: add licensing information to README
PR-URL: https://github.com/libuv/libuv/pull/887
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Fedor Indutny <fedor@indutny.com>
2016-05-28 12:55:58 +02:00
Saúl Ibarra Corretgé
341097403d doc: add ability to live reload and regenerate HTML
PR-URL: https://github.com/libuv/libuv/pull/819
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-04-11 12:52:59 -03:00
Saúl Ibarra Corretgé
2543f56406 doc: add missing link in README
PR-URL: https://github.com/libuv/libuv/pull/722
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-02-15 09:57:21 +01:00
Saúl Ibarra Corretgé
67e22296d7 doc: describe how to make release builds on Unix
Refs: https://github.com/libuv/libuv/issues/550
PR-URL: https://github.com/libuv/libuv/pull/722
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-02-15 09:56:56 +01:00
Angel Leon
f3216246a2 doc: fix typo in README
PR-URL: https://github.com/libuv/libuv/pull/598
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2015-11-04 21:55:28 +01:00
Saúl Ibarra Corretgé
4bfaaff864 doc: add note about Windows binaries to the README 2015-08-05 22:34:25 +02:00
Saúl Ibarra Corretgé
dbca917bad doc: document the procedure for verifying releases
Refs: https://github.com/libuv/libuv/issues/409
2015-08-05 22:34:25 +02:00
Andrew Paprocki
bb2632b339 aix: add ahafs autoconf detection and README notes
The libuv filesystem events API on AIX requires the non-default IBM
`bos.ahafs` package to be installed.  The library should still compile
and work on systems without this package.  This patch adds proper
detection to `configure.ac` and makes the API return `-ENOSYS` at
runtime if the system does not support it.

PR-URL: https://github.com/libuv/libuv/pull/372
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2015-05-28 11:16:00 +02:00
Devchandra Meetei Leishangthem
2eb1c18240 build: add documentation for ninja support
PR-URL: https://github.com/libuv/libuv/pull/290
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2015-03-26 15:45:09 +01:00
Saúl Ibarra Corretgé
508cd3c220 doc: clarify that we don't maintain external doc resources
PR-URL: https://github.com/libuv/libuv/pull/284
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2015-03-23 10:56:40 +01:00
Stephen von Takach
5abb33dd7b build: update the location of gyp
Google moved the repository

PR-URL: https://github.com/libuv/libuv/pull/240
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2015-03-03 10:13:14 +01:00
Saúl Ibarra Corretgé
e7895debea doc: update README with IRC channel
PR-URL: https://github.com/libuv/libuv/pull/26
2014-12-03 12:03:49 +01:00
Joey Geralnik
45c7ccce21 doc: fix spelling
Fix various typos and spelling mistakes in the documentation

PR-URL: https://github.com/libuv/libuv/pull/17
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2014-11-29 04:22:56 +01:00
Ben Noordhuis
7ce1113885 doc,build,include: update project links
The project home has moved from https://github.com/joyent/libuv to
https://github.com/libuv/libuv.  Update the links inside the repo.
2014-11-25 15:39:12 +01:00
Elijah Andrews
156069130f readme: remove Rust from users
Closes #1572
2014-11-20 19:40:35 +01:00
Ben Noordhuis
f914721c24 build: add x32 support to gyp build
This commit adds x32 support to the gyp build.  Configure with:

    $ ./gyp_uv.py -Dtarget_arch=x32
2014-11-10 20:12:22 -03:00
Thorsten Lorenz
3f585626a4 doc: add learnuv workshop to README 2014-11-06 19:25:42 -05:00
Mikhail Mukovnikov
41ddd1f267 doc: mention homebrew in README 2014-11-06 19:22:35 -05:00
Emmanuel Odeke
b174a84e39 doc: fix git/svn url for gyp repo in README 2014-10-26 07:44:57 -03:00
Jeff Widman
471e844793 doc: fix punctuation and grammar in README 2014-10-06 09:03:25 +02:00
Saúl Ibarra Corretgé
95797f48e8 doc: mention API documentation in README 2014-09-11 09:38:35 +02:00
Saúl Ibarra Corretgé
49ec7ca213 doc: update README with versioning information 2014-08-29 10:32:16 +02:00
Saúl Ibarra Corretgé
645e2a2855 doc: update link to pyuv in README 2014-07-27 12:33:02 +02:00
Saúl Ibarra Corretgé
06c60e9662 doc: add logo image to README 2014-07-20 19:38:46 +02:00
Jay Satiro
90e4afd4fa windows: fix PYTHON environment variable usage
- (README.md) The PYTHON environment variable should point to python.exe
not the python directory.

- (vcvars.bat) The PYTHON environment variable should be quoted on
expansion in case there's spaces in the path.
2014-06-11 23:01:32 +02:00
Saúl Ibarra Corretgé
a442aa7643 doc: small fixes to comments and syntax 2014-02-23 18:01:03 +01:00
Nathan Sweet
acb9f8951e doc: adding ARCHS flag to OS X build command
Adding further instructions about building for OS X, as recent versions
of xcodebuild will automatically build for i386 (can someone say,
"monoculture") even on x86_64 machines! Specifically including
instructions about including the "ARCHS" flag to specify the right
architecture.

This is trivial, but will save people time.
2014-01-13 17:43:25 +00:00
Saúl Ibarra Corretgé
7d23c1d7b9 doc: add libuv-dox to the documentation section 2013-12-27 13:17:56 +01:00
Andrius Bentkus
20253414c3 doc: add readme link to all projects that use libuv. 2013-12-25 20:42:58 +02:00
Maciej Małecki
8094ac2129 doc: document how to run tests 2013-12-05 14:56:53 +04:00
Tenor Biel
2e58ea8fd5 doc: fixed typo in readme
The link to nodejs.org in README.md was broken.
2013-11-30 20:21:39 -08:00
Bert Belder
39db22594d doc: add guidelines for contributing 2013-12-01 03:23:18 +01:00
Geert Jansen
2445467810 build: fix windows smp build with gyp
Gyp will try a parallel build if it detect the system has >1 processor.
This functionality depends on the Python "multiprocessing" package. The
multiprocessing package on Windows requires that the top-level module is
importable as a module, see:

  http://docs.python.org/2/library/multiprocessing.html#windows

This fixes issue #984.
2013-11-05 14:28:10 +01:00
Bert Belder
581e8c9266 doc: update readme
Update the intro blurb and spend a few more words on libuv's features.
2013-09-23 11:38:03 +02:00
Brian Kaisner
8e23b046a6 build: clarify instructions for Windows
Clarified up front that Python must be installed for all Windows builds
and it must be in the path. Simplified the Windows instructions by
removing the redundant msbuild guidance.

Also added subheadings for each unique build environment.
2013-09-05 21:17:58 +02:00
Ben Noordhuis
d6464c87bd build: remove _GNU_SOURCE macro definition
Compile libuv without -D_GNU_SOURCE, remove mention from the README.

The only place where it's still used is in the test suite and only
because test/test-fs.c uses struct stat directly.
2013-08-24 22:00:48 +02:00
Ben Noordhuis
ddd7e04fd6 build: switch to autotools
Switch to the build tool everyone loves to hate.  The Makefile has
served us well over the years but it's been acquiring more and more
features that autotools gives us for free, like easy static+shared
library building, sane install targets, and so on.

This commit drops MinGW support.  If there is demand for it, we'll
re-add it.
2013-07-02 01:21:16 +02:00
Linus Mårtensson
3fdd2a1128 uv: support android libuv standalone build
Tested most of my compilation in the previous patch on NodeJS
and extracted the patches from there. This patch ensures libuv
will be capable of building standalone as well, both with gyp
and Makefiles.

Build documentation was added to the README.md file.

Some tests are failing, and I have not heavily investigated
the reasons. The failures are generally on errors, and are
likely related to differences between fully POSIX-compatible
systems and android.
2013-05-31 13:25:17 +02:00
Ben Noordhuis
2c2327be39 doc: explain how to build a .so 2013-05-30 02:28:06 +02:00
Ben Kelly
8ef07ccac7 doc: add link to Visual Studio Express in README 2013-04-08 00:05:02 +02:00
Ben Noordhuis
bd20b37170 doc: update README, s/OS/PLATFORM/
Commit a9740c9 changed the name of the OS var to PLATFORM but forgot to
update the README.
2013-03-26 14:50:21 +01:00