summaryrefslogtreecommitdiff
path: root/tools/bootstrap
diff options
context:
space:
mode:
authorBartosz Sosnowski <bartosz@janeasystems.com>2017-11-14 15:57:11 +0100
committerBartosz Sosnowski <bartosz@janeasystems.com>2017-11-30 11:35:45 +0100
commit61d46dd7e05021ac1e5f9add415fbaf36b17d5ff (patch)
treecdb600da4ff65e2e34fd7d9206ad8d6705f996ee /tools/bootstrap
parentfff3792e7187eb2bebf8ee1bada93d2fb29802c3 (diff)
downloadandroid-node-v8-61d46dd7e05021ac1e5f9add415fbaf36b17d5ff.tar.gz
android-node-v8-61d46dd7e05021ac1e5f9add415fbaf36b17d5ff.tar.bz2
android-node-v8-61d46dd7e05021ac1e5f9add415fbaf36b17d5ff.zip
tools: add Boxstarter script
Adds a Boxstarter script for easy Node.js building prerequisites installation PR-URL: https://github.com/nodejs/node/pull/17046 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: João Reis <reis@janeasystems.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Diffstat (limited to 'tools/bootstrap')
-rw-r--r--tools/bootstrap/README.md55
-rw-r--r--tools/bootstrap/windows_boxstarter21
2 files changed, 76 insertions, 0 deletions
diff --git a/tools/bootstrap/README.md b/tools/bootstrap/README.md
new file mode 100644
index 0000000000..a61e947a2a
--- /dev/null
+++ b/tools/bootstrap/README.md
@@ -0,0 +1,55 @@
+# Node.js Bootstrapping Guide
+
+## Windows
+
+A [Boxstarter][] script can be used for easy setup of Windows systems with all
+the required prerequisites for Node.js development. This script will install
+the following [Chocolatey] packages:
+ * [Git for Windows][] with the `git` and Unix tools added to the `PATH`
+ * [Python 2.x][]
+ * [Visual Studio 2017 Build Tools][] with [Visual C++ workload][]
+
+To install Node.js prerequisites using [Boxstarter WebLauncher][], just open
+[this link](http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/nodejs/node/master/tools/bootstrap/windows_boxstarter)
+with Internet Explorer or Edge browser on the target machine.
+
+Alternatively, you can use PowerShell. Run those commands from an elevated
+PowerShell terminal:
+```console
+Set-ExecutionPolicy Unrestricted -Force
+iex ((New-Object System.Net.WebClient).DownloadString('http://boxstarter.org/bootstrapper.ps1'))
+get-boxstarter -Force
+Install-BoxstarterPackage https://raw.githubusercontent.com/nodejs/node/master/tools/bootstrap/windows_boxstarter -DisableReboots
+```
+
+Entire installation will take up about 8 GB of disk space.
+
+## Linux
+
+For building Node.js on Linux, following packages are required (note, that this
+can vary from distribution to distribution):
+ * `git`
+ * `python`
+ * `gcc-c++` or `g++`
+ * `make`
+
+To bootstrap Node.js on Linux, run in terminal:
+ * OpenSUSE: `sudo zypper install git python gcc-c++ make`
+ * Fedora: `sudo dnf install git python gcc-c++ make`
+ * Ubuntu, Debian: `sudo apt-get install git python g++ make`
+
+## macOS
+
+To install required tools on macOS, run in terminal:
+```console
+xcode-select --install
+```
+
+[Boxstarter]: http://boxstarter.org/
+[Boxstarter WebLauncher]: http://boxstarter.org/WebLauncher
+[Chocolatey]: https://chocolatey.org/
+[Git for Windows]: https://chocolatey.org/packages/git
+[Python 2.x]: https://chocolatey.org/packages/python2
+[Visual Studio 2017 Build Tools]: https://chocolatey.org/packages/visualstudio2017buildtools
+[Visual C++ workload]: https://chocolatey.org/packages/visualstudio2017-workload-vctools
+
diff --git a/tools/bootstrap/windows_boxstarter b/tools/bootstrap/windows_boxstarter
new file mode 100644
index 0000000000..144c309ae1
--- /dev/null
+++ b/tools/bootstrap/windows_boxstarter
@@ -0,0 +1,21 @@
+# Boxstarter (http://boxstarter.org/) script for Node.js prerequisites
+#
+# To install either open this link in IE or Edge:
+# http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/nodejs/node/master/tools/bootstrap/windows_boxstarter
+#
+# Or run those commands in an elevated Powershell terminal:
+# iex ((New-Object System.Net.WebClient).DownloadString('http://boxstarter.org/bootstrapper.ps1'))
+# get-boxstarter -Force
+# Install-BoxstarterPackage https://raw.githubusercontent.com/nodejs/node/master/tools/bootstrap/windows_boxstarter -DisableReboots
+#
+# For more detail see
+# https://github.com/nodejs/node/blob/master/tools/bootstrap/README.md
+#
+
+# Git and Unix tools will be added to the PATH
+choco install git -params /GitAndUnixToolsOnPath -y
+choco install python2 -y
+
+# Installs VS 2017 Build Tools
+choco install visualstudio2017buildtools -y
+choco install visualstudio2017-workload-vctools -y