You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 15, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: content/hacking-atom/sections/hacking-on-atom-core.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,33 +83,35 @@ In order to build Atom from source, you need to have a number of other requireme
83
83
##### Requirements
84
84
85
85
* macOS 10.9 or later
86
-
* Node.js 6.x or later (we recommend installing it via [nvm](https://github.com/creationix/nvm))
87
-
* npm 3.10.x or later (run `npm install -g npm`)
88
-
* Python v2.7.x
86
+
* Node.js 10.12 or later (we recommend installing it via [nvm](https://github.com/creationix/nvm))
87
+
* npm 6.12 or later (run `npm install -g npm`)
88
+
* Python v2.6.x, v2.7.x or v3.5+
89
89
* Command Line Tools for [Xcode](https://developer.apple.com/xcode/downloads/) (run `xcode-select --install` to install)
90
90
91
91
{{/mac}}
92
92
93
93
{{#windows}}
94
94
95
-
* Node.js 6.9.4 or later (the architecture of node available to the build system will determine whether you build 32-bit or 64-bit Atom)
96
-
* Python v2.7.x
97
-
* The `python.exe` must be available at `%SystemDrive%\Python27\python.exe`. If it is installed elsewhere create a symbolic link to the directory containing the `python.exe` using: `mklink /d %SystemDrive%\Python27 D:\elsewhere\Python27`
98
-
* 7zip (7z.exe available from the command line) - for creating distribution zip files
99
-
* C++ build tools, either:
100
-
*[Visual C++ Build Tools 2015](https://visualstudio.microsoft.com/vs/older-downloads/)
101
-
*[Visual Studio 2013 Update 5](https://www.visualstudio.com/downloads/) (Express Edition or better)
102
-
*[Visual Studio 2015](https://www.visualstudio.com/downloads/) (Community Edition or better)
103
-
***Unsupported** but more convenient for some who know Node: [windows-build-tools](https://www.npmjs.com/package/windows-build-tools)
104
-
95
+
* Node.js 10.12 or later (the architecture of node available to the build system will determine whether you build 32-bit or 64-bit Atom)
96
+
* npm 6.12 or later (run `npm install -g npm`)
97
+
* Python v2.6.x, v2.7.x, or v3.5+
98
+
*[Get Python from the Microsoft Store](https://www.microsoft.com/en-us/search/shop/apps?q=python+software+foundation&devicetype=pc&category=Developer+tools%5cDevelopment+kits&Price=0&MaturityRating=ESRB%3aE), or
99
+
* Download Python from https://www.python.org/downloads/.
100
+
* For Python 2, be sure to install in the default location, or check "Add Python 2.x to PATH" before installing.
101
+
* For Python 3, check "Add Python 3.x to PATH", or change the install path to `[Your_Drive_Letter]:\Python37` e.g. `C:\Python37`, (even if your version of Python 3 isn't 3.7, that's one place where the scripts will look.)
102
+
* If python isn't found by the bootstrap script, create a symbolic link to the directory containing `python.exe` using e.g.: `mklink /d %SystemDrive%\Python27 D:\elsewhere\Python27`(Links should be set at either `%SystemDrive%\Python27` or `%SystemDrive%\Python37`, regardless of what version of Python you actually have.)
103
+
* C++ build tools:
104
+
***Option 1:**[windows-build-tools](https://www.npmjs.com/package/windows-build-tools) - From an elevated Powershell window (right click and "run as Administrator") do: `npm install --global windows-build-tools@4` to install
105
+
***Option 2:**[Visual C++ Build Tools 2015 or 2017](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
106
+
***Option 3:**[Visual Studio 2015 or 2017](https://www.visualstudio.com/downloads/) (Community Edition or better)
105
107
106
108
Also ensure that:
107
109
108
110
* The default installation folder is chosen so the build tools can find it
109
111
* If using Visual Studio make sure Visual C++ support is selected/installed
110
-
* If using Visual C++ Build Tools make sure Windows 8 SDK is selected/installed
112
+
* If using Visual C++ Build Tools make sure a Windows SDK (Windows 8 SDK or Windows 10 SDK) is selected/installed
111
113
* A `git` command is in your path
112
-
* Set the `GYP_MSVS_VERSION` environment variable to the Visual Studio/Build Tools version (`2013` or `2015`) e.g. ``[Environment]::SetEnvironmentVariable("GYP_MSVS_VERSION", "2015", "User")`` in PowerShell (or set it in Windows advanced system settings).
114
+
* Set the `GYP_MSVS_VERSION` environment variable to the Visual Studio/Build Tools version (`2015` or `2017`.) e.g. ``[Environment]::SetEnvironmentVariable("GYP_MSVS_VERSION", "2015", "User")`` in PowerShell (or set it in Windows advanced system settings).
113
115
114
116
{{/windows}}
115
117
@@ -122,9 +124,9 @@ Ubuntu LTS 16.04 64-bit is the recommended platform.
122
124
* OS with 64-bit or 32-bit architecture
123
125
* C++11 toolchain
124
126
* Git
125
-
* Node.js 6.x or later (we recommend installing it via [nvm](https://github.com/creationix/nvm))
126
-
* npm 3.10.x or later (run `npm install -g npm`)
127
-
*Ensure node-gyp uses python2 (run `npm config set python /usr/bin/python2 -g`, use `sudo` if you didn't install node via nvm)
127
+
* Node.js 10.12 or later (we recommend installing it via [nvm](https://github.com/creationix/nvm))
128
+
* npm 6.12 or later (run `npm install -g npm`)
129
+
*Python 2.6.x, 2.7.x or 3.5+
128
130
* Development headers for [libsecret](https://wiki.gnome.org/Projects/Libsecret).
129
131
130
132
For more details, scroll down to find how to setup a specific Linux distro.
Be certain to use `export PYTHON=/usr/bin/python2` before building Atom.
169
-
170
170
###### Slackware
171
171
172
172
```command-line
@@ -228,7 +228,7 @@ To also install the newly built application, use the `--create-debian-package` o
228
228
##### `script\build` Options
229
229
230
230
*`--code-sign`: signs the application with the GitHub certificate specified in `$WIN_P12KEY_URL`.
231
-
*`--compress-artifacts`: zips the generated application as `out\atom-windows.zip` (requires [7-Zip](http://www.7-zip.org)).
231
+
*`--compress-artifacts`: zips the generated application as `out\atom-windows.zip`.
232
232
*`--create-windows-installer`: creates an `.exe` and two `.nupkg` packages in the `out` directory.
233
233
*`--install[=dir]`: installs the application in `${dir}\Atom\app-dev`; `${dir}` defaults to `%LOCALAPPDATA%`.
234
234
@@ -262,7 +262,7 @@ Use [this search](https://github.com/atom/atom/search?q=label%3Abuild-error+labe
262
262
263
263
*`msbuild.exe failed with exit code: 1`
264
264
* If using **Visual Studio**, ensure you have the **Visual C++** component installed. Go into Add/Remove Programs, select Visual Studio, press Modify, and then check the Visual C++ box.
265
-
* If using **Visual C++ Build Tools**, ensure you have the **Windows 8 SDK** component installed. Go into Add/Remove Programs, select Visual C++ Build Tools, press Modify and then check the Windows 8 SDK box.
265
+
* If using **Visual C++ Build Tools**, ensure you have the **Windows 8 SDK**or **Windows 10 SDK**component installed. Go into Add/Remove Programs, select Visual C++ Build Tools, press Modify and then check the "Windows 8 SDK" or "Windows 10 SDK" box.
266
266
267
267
*`script\build` stops with no error or warning shortly after displaying the versions of node, npm and Python
268
268
* Make sure that the path where you have checked out Atom does not include a space. For example, use `C:\atom` instead of `C:\my stuff\atom`.
@@ -281,7 +281,7 @@ Use [this search](https://github.com/atom/atom/search?q=label%3Abuild-error+labe
281
281
* See the next item.
282
282
283
283
*`error MSB8020: The build tools for Visual Studio 201? (Platform Toolset = 'v1?0') cannot be found.`
284
-
* Try setting the `GYP_MSVS_VERSION` environment variable to **2013** or **2015** depending on what version of Visual Studio/Build Tools is installed and then `script\clean` followed by `script\build` (re-open the Command Prompt if you set the variable using the GUI).
284
+
* Try setting the `GYP_MSVS_VERSION` environment variable to **2015** or **2017** depending on what version of Visual Studio/Build Tools is installed and then `script\clean` followed by `script\build` (re-open the Command Prompt if you set the variable using the GUI).
285
285
286
286
*`'node-gyp' is not recognized as an internal or external command, operable program or batch file.`
287
287
* Try running `npm install -g node-gyp`, and run `script\build` again.
0 commit comments