aboutsummaryrefslogtreecommitdiff
path: root/BUILDING.md
AgeCommit message (Collapse)Author
2016-09-28doc: remove failing workaround in BUILDING.mdChristopher Fujino
Updated BUILDING.md, removing workaround for Python conflicts that didn't work. PR-URL: https://github.com/nodejs/node/pull/8763 Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Bryan English <bryan@bryanenglish.com> Reviewed-By: James M Snell <jasnell@gmail.com> Refs: https://github.com/nodejs/node/pull/8763
2016-09-27doc: enable first-heading-level remark-lint ruleСковорода Никита Андреевич
This makes sure that the first heading in all markdown files is h1. Only three files needed to be changed to conform: 1. BUILDING.md 2. CODE_OF_CONDUCT.md 3. doc/onboarding-extras.md Also, .remarkrc is updated to include the `first-heading-level: 1` rule in order to catch similar issues in the future. PR-URL: https://github.com/nodejs/node/pull/8716 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-09-24doc: update BUILDING.mdrainabba
Added note about vcbuild being included as batch to clarify that it's not needed from msbuild tools or visual studio. PR-URL: https://github.com/nodejs/node/pull/8704 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-09-06doc: update BUILDING.mdRich Trott
* General copy-editing * Move `[sudo] make install` step from general Unix build to own step * Remove `make test-addons` as that is now covered by `make test` * Standardize on `/path/to/foo` as used elsewhere in the doc * Change `node -e` to `./node -e` to avoid using different node binary PR-URL: https://github.com/nodejs/node/pull/8398 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-08-12doc: update windows prerequisitesBen Noordhuis
Visual Studio 2013 is no longer supported. Update the Windows build prerequisites. Refs: https://github.com/nodejs/node/issues/7484 PR-URL: https://github.com/nodejs/node/pull/8049 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: João Reis <reis@janeasystems.com>
2016-08-04doc: *.md formatting fixes in the top-level dirСковорода Никита Андреевич
Continuing what a58b48bc3bcf43f7090d4cc914606af68fe55815 did for the doc/ dir, this fixes some formatting issues in the *.md files that are placed directly in the top-level directory. README.md changes are excluded as they are covered by https://github.com/nodejs/node/pull/7971 Refs: https://github.com/nodejs/node/pull/7637 PR-URL: https://github.com/nodejs/node/pull/7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-23doc: update build instructions for WindowsJoão Reis
The Visual C++ Build Tools are supported to build Node on Windows and already used in CI, so they should be included in the build instructions. Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> PR-URL: https://github.com/nodejs/node/pull/7285
2016-05-10build: add Make `doc-only` targetJesse McCarthy
Allows building just docs using existing Node instead of building Node first. PR-URL: https://github.com/nodejs/node/pull/3888 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2016-05-09doc: add steps for running addons + npm testsMyles Borins
Currently we do not document how to run the test suite for native modules or for npm. This commit updates BUILDING.md with the information needed to do so. It includes a caveat about Node v4 and earlier requiring `make install` to be run before running the npm test suite. PR-URL: https://github.com/nodejs/node/pull/6231 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2016-05-04tools: Check in tools for shrinking ICU size, change default to small-icuSteven R. Loomis
* Change configure default to "small-icu" (Intl on, English only) * add "--without-intl" and "vcbuild without-intl" options, equivalent to --with-intl=none * update BUILDING.md with above changes * Checks in tools that generate the deps/icu-small source directory from ICU source * Tools and process for updating ICU documented in tools/icu/README.md Fixes: https://github.com/nodejs/node/issues/3476 PR-URL: https://github.com/nodejs/node/pull/6088 Reviewed-By: James M Snell <jasnell@gmail.com>
2016-04-28doc: update build instructions for OS XRich Trott
Building Node.js on OS X requires XCode (because node-gyp requires XCode). Add that information to BUILDING.md. Additionally, this changes references to `Macintosh` in BUILDING.md to refer to `OS X`. This is consistent with the way other references are to operating system families (`Unix`, `Windows`) and not brand names or hardware architectures. PR-URL: https://github.com/nodejs/node/pull/6309 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
2016-04-06doc: note about Android supportRich Trott
PR-URL: https://github.com/nodejs/node/pull/6040 Refs: https://github.com/nodejs/node/issues/6035 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-03-14doc: move build instructions to a new documentJohan Bergström
This makes README.md easier to consume and likely less confusing for people that get it as part of a binary download. PR-URL: https://github.com/nodejs/node/pull/5634 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: James M Snell <jasnell@gmail.com>