Felix Rieseberg
8949672ae8
chore: Update readme
2024-10-07 09:42:06 -04:00
Victor Ejike Nwosu
77737e45db
Add Chocolatey Guide for node-gyp on Windows ( #3008 )
...
* Add chocolatey install
* Revert unwanted diffs
* Add chocolatey guide
* Use bash for code block
* Update README.md
Co-authored-by: Christian Clauss <cclauss@me.com>
* Move chocolatey bash to top
* Fix section identation
---------
Co-authored-by: Christian Clauss <cclauss@me.com>
2024-04-07 22:04:04 +02:00
Christian Clauss
a6b48fca99
docs: Installation -- Python >= v3.12 requires node-gyp
>= v10 ( #3010 )
...
We are getting a lot of issues opened on this topic so add it to our installation instructions.
* #2869
> [!Important]
> Python >= v3.12 requires `node-gyp` >= v10
2024-04-07 10:59:14 +01:00
SmallY
9fd7936f0d
docs: add the way to configuring Python dependency for Windows PowerShell ( #2996 )
2024-04-03 10:29:34 +01:00
Jaroslav
109e3d4245
feat: improve visual studio detection ( #2957 )
...
Detect visual studio installation using the VSSetup module and
Get-VSSetupInstance method. It works even in systems with the
Constrained language mode of PowerShell.
2024-02-09 02:33:54 +01:00
Davee
a87d0bf458
refine readme Visual C++ Build Environment text for clarity ( #2965 )
...
* refine readme text for clarity
* refine readme Visual C++ build env for clarity
2024-01-25 21:23:49 +01:00
Artur Yapparov
ae8478ec32
docs: remove outdated Node versions from readme ( #2955 )
...
Refs: https://github.com/nodejs/node-gyp/issues/2953
2023-12-25 14:07:56 +01:00
David Sanders
d644ce4831
docs: update applicable GitHub links from master to main ( #2843 )
...
Signed-off-by: David Sanders <dsanders11@ucsbalum.com>
2023-10-27 16:53:27 -07:00
Iulian Onofrei
d3615c66f7
Fix incorrect Xcode casing in README ( #2896 )
2023-08-26 10:48:03 +02:00
Christian Clauss
bb93b946a9
docs: README.md Do not hardcode the supported versions of Python ( #2880 )
2023-08-25 21:04:27 +08:00
Rareș
c9caa2ecf3
docs: Update windows installation instructions in README.md ( #2882 )
...
* Update windows installation instructions in README.md
2023-07-13 18:08:41 +02:00
Dennis Ameling
bb76021d35
feat: add support for native windows arm64 build tools
...
Visual Studio 2022 17.4 adds a native C++ compiler for Windows on ARM.
This allows arm64 devices to leverage native build tools, leading to
a 35% (or more) speed increase.
https://devblogs.microsoft.com/visualstudio/arm64-visual-studio-is-officially-here/
Signed-off-by: Dennis Ameling <dennis@dennisameling.com>
2023-05-25 12:29:04 +02:00
Maksim Beliaev
c7927e228d
doc: Update README.md ( #2822 )
...
Co-authored-by: Christian Clauss <cclauss@me.com>
2023-04-10 17:34:26 +08:00
Nick Wang
d7687d5566
Clarify wording to redirect to macOS_Catalina.md ( #2588 )
2022-06-10 14:13:05 +02:00
Doni Rubiagatra
bf81cd452b
fix: typo on readme
2022-05-11 13:46:42 +10:00
Christian Clauss
e069f13658
doc: Update Python versions ( #2571 )
...
* Add Python 3.10
* Drop Python 3.6 which [EOLs on 23 Dec. 2021](https://devguide.python.org/#status-of-python-branches )
* macOS: clarify `Xcode Command Line Tools` standalone vs. from full Xcode
* Window: Use the same URL as https://github.com/nodejs/node/blob/master/BUILDING.md#windows
2022-01-30 23:13:36 +01:00
Cheng Zhao
a27dc08696
feat: build with config.gypi from node headers
2021-11-05 20:08:28 +11:00
nineninesevenfour
660dd7b2a8
doc: correct link to "binding.gyp files out in the wild" ( #2483 )
...
correct link to "binding.gyp files out in the wild"
2021-08-13 21:59:46 +10:00
Rod Vagg
b52e487eac
doc(wiki): link to docs/ from README
2021-06-23 13:01:07 +10:00
Jiawen Geng
14236709de
doc: remove redundant version info ( #2403 )
2021-05-19 16:36:27 +08:00
Gustavo de León
1b4697abf6
doc: Update README.md Visual Studio Community page polski to auto ( #2371 )
...
changed URL of Visual Studio Community from a default polski URL to the one without the lenguage code
2021-05-19 15:41:39 +08:00
Jiawen Geng
a5fd1f41e3
doc: add downloads badge ( #2352 )
...
PR-URL: https://github.com/nodejs/node-gyp/pull/2352
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
2021-03-29 09:49:57 +08:00
Christian Clauss
a78b584236
gyp: remove support for Python 2 ( #2300 )
...
PR-URL: https://github.com/nodejs/node-gyp/pull/2300
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2021-02-14 12:51:19 +08:00
மனோஜ்குமார் பழனிச்சாமி
6287118fc4
doc: updated README.md to copy easily ( #2281 )
...
PR-URL: https://github.com/nodejs/node-gyp/pull/2281
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2020-12-19 21:23:43 +08:00
Rod Vagg
754996b9ec
doc: replace status badges with new Actions badge
...
PR-URL: https://github.com/nodejs/node-gyp/pull/2218
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Matias Lopez <imatlopez@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2020-10-15 10:24:59 +11:00
DeeDeeG
2cca9b74f7
doc: drop the --production flag for installing windows-build-tools
...
This isn't needed, and was probably copy-pasted from
windows-build-tools' README.md, which has since been changed
to drop the `--production` flag from the install instructions.
PR-URL: https://github.com/nodejs/node-gyp/pull/2206
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2020-10-15 10:24:33 +11:00
Ujjwal Sharma
e529f3309d
doc: update README to reflect upgrade to gyp-next
...
PR-URL: https://github.com/nodejs/node-gyp/pull/2092
Reviewed-By: Rod Vagg <rod@vagg.org>
2020-05-26 15:14:56 +10:00
Matheus Marchini
9aed6286a3
doc: give more attention to Catalina issues doc
...
It's easy to miss the Catalina issues doc when reading the readme. Since
it can be a common issue among developers, it makes sense to give more
attention to it in the readme.
PR-URL: https://github.com/nodejs/node-gyp/pull/2134
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Christian Clauss <cclauss@me.com>
2020-05-26 15:03:32 +10:00
Michaël Zasso
473cfa283f
doc: note in README that Python 3.8 is supported ( #2072 )
...
PR-URL: https://github.com/nodejs/node-gyp/pull/2072
Refs: https://github.com/nodejs/node-gyp/issues/2071
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2020-03-16 17:45:32 +08:00
Rod Vagg
9a7dd16b76
doc: remove backticks from Python version list
...
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Christian Clauss <cclauss@me.com>
PR-URL: https://github.com/nodejs/node-gyp/pull/2011
2020-01-06 14:21:43 +11:00
Rod Vagg
26cd6eaea6
doc: add GitHub Actions badge ( #1994 )
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1994
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2019-12-29 15:50:15 +08:00
Matias Lopez
3bcba2a01a
lib: noproxy support, match proxy detection to request
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1978
Reviewed-By: Rod Vagg <rod@vagg.org>
2019-12-16 10:53:03 +11:00
Suraneti Rodsuwan
f7b6b6b77b
doc: fix typo in README.md ( #1985 )
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1985
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2019-12-16 10:35:53 +11:00
Rod Vagg
6b8f2652dd
doc: add travis badge
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1971
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2019-11-21 21:08:36 +11:00
cclauss
8ec2e681d5
doc: add macOS_Catalina.md document
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1940
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2019-11-01 21:12:57 +11:00
Dan Pike
3538a317b6
doc: adjustments to the README.md for new users
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1919
Reviewed-By: Rod Vagg <rod@vagg.org>
2019-10-24 14:50:36 +11:00
Sam Roberts
b1bf32ed1b
doc: clarify Python configuration, etc
...
Clarify that:
- node-gyp is not used to build Node.js
- PYTHON can be used to add a Python search path
- NODE_GYP_FORCE_PYTHON can be used to override all Python search paths
- That a compatible Python is searched for
PR-URL: https://github.com/nodejs/node-gyp/pull/1908
Reviewed-By: Christian Clauss <cclauss@me.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-10-04 13:27:09 +10:00
Christian Clauss
f60ed47d14
travis: add Python 3.5 and 3.6 tests on Linux
...
Support the same Python versions as the Python Core Team: https://devguide.python.org/#branchstatus
PR-URL: https://github.com/nodejs/node-gyp/pull/1903
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: João Reis <reis@janeasystems.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-10-03 11:15:34 +10:00
cclauss
c763ca1838
doc: Declare that node-gyp is Python 3 compatible
...
NOTE: node-gyp is compatible with both Python 2.7 and 3.7 but Node.js itself is not yet compatible with Python 3.
PR-URL: https://github.com/nodejs/node-gyp/pull/1811
Reviewed-By: João Reis <reis@janeasystems.com>
2019-09-30 21:21:24 +10:00
Nhan Khong
8d4ea7f13e
doc: update xcode install instructions to match Node's BUILDING
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1884
Reviewed-By: Rod Vagg <rod@vagg.org>
2019-09-26 12:14:06 +10:00
lagorsse
ca990a1292
doc: fix missing argument for setting python path
...
(accepted with minor modifications by rvagg)
PR-URL: https://github.com/nodejs/node-gyp/pull/1802
Reviewed-By: Rod Vagg <rod@vagg.org>
2019-09-26 11:55:27 +10:00
David Sanders
e3861722ed
doc: document --jobs max
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1770
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2019-06-20 11:20:24 +10:00
Jon Kunkee
997bc3c748
readme: add ARM64 info to MSVC setup instructions
...
Since ARM64 build dependencies are not included in the "Desktop
development with C++" workload of Visual Studio 2017, this change adds
a note explaining what additional components are required to build
native modules for the new Windows platform.
PR-URL: https://github.com/nodejs/node-gyp/pull/1655
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: João Reis <reis@janeasystems.com>
2019-04-24 10:29:01 +10:00
Taylor D. Lee
cca2d66727
doc: python info needs own header
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1245
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
2019-04-24 10:29:00 +10:00
Selwyn
8a83972743
bin: follow XDG OS conventions for storing data
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1570
Fixes: https://github.com/nodejs/node-gyp/pull/175
Fixes: https://github.com/nodejs/node-gyp/pull/1124
Reviewed-By: Refael Ackermann <refack@gmail.com>
2019-04-24 10:29:00 +10:00
Jon Moss
3e64c780f5
doc: lint README.md
...
Fixes grammar, removes extra lines and spaces, etc. Also removes a few
references to `node-waf`, which was removed ~6 years ago now. Happy to
add back if people still need that information.
PR-URL: https://github.com/nodejs/node-gyp/pull/1498
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-04-24 10:27:29 +10:00
Ivan Daniluk
c5929cb4fe
doc: update Xcode preferences tab name.
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1330
Reviewed-By: Jon Moss <me@jonathanmoss.me>
2018-08-09 10:45:12 +10:00
Bartosz Sosnowski
b4fe8c16f9
doc: fix visual studio links
...
Fixes: https://github.com/nodejs/node-gyp/issues/1472
PR-URL: https://github.com/nodejs/node-gyp/pull/1490
Reviewed-By: Jon Moss <me@jonathanmoss.me>
2018-08-09 10:45:12 +10:00
Josh Parnham
79febace53
doc: update macOS information in README
...
PR-URL: https://github.com/nodejs/node-gyp/pull/1323
Fixes: https://github.com/nodejs/node-gyp/issues/1295
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2018-06-08 17:09:27 +02:00
Ben Noordhuis
2580b9139e
Update --nodedir
description in README.
...
The description erroneously stated that it should point the node binary.
It needs to point to the node source code.
PR-URL: https://github.com/nodejs/node-gyp/pull/1372
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2018-06-08 17:09:27 +02:00