Skip to content

doc: add note about pip being required #40669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
PiotrRybak wants to merge 4 commits into from
Closed

doc: add note about pip being required #40669

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1248fda
doc: remove extra 'or'
PiotrRybak Oct 30, 2021
80698d4
doc: add note about pip being required
PiotrRybak Oct 31, 2021
76bbece
doc: put information about pip in sub-bullet
PiotrRybak Oct 31, 2021
293e518
doc: update mac instructions, move pip to the end of dependencie
PiotrRybak Nov 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: add note about pip being required 
Clean install requires pip to make coverage but instructions didn't
mention it.
  • Loading branch information
@PiotrRybak
PiotrRybak committed Nov 3, 2021
commit 80698d4cda6a6e3519c5d98c3616d63154982726
14 changes: 7 additions & 7 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,22 +235,22 @@ The Node.js project supports Python >= 3 for building and testing.

* `gcc` and `g++` >= 8.3 or newer
* GNU Make 3.81 or newer
* Python 3.6, 3.7, 3.8, 3.9, or 3.10 (see note above)
* Python 3.6, 3.7, 3.8, 3.9, or 3.10 (see note above) with pip installed
Comment thread
PiotrRybak marked this conversation as resolved.
Outdated

Installation via Linux package manager can be achieved with:

* Ubuntu, Debian: `sudo apt-get install python3 g++ make`
* Fedora: `sudo dnf install python3 gcc-c++ make`
* CentOS and RHEL: `sudo yum install python3 gcc-c++ make`
* OpenSUSE: `sudo zypper install python3 gcc-c++ make`
* Arch Linux, Manjaro: `sudo pacman -S python gcc make`
* Ubuntu, Debian: `sudo apt-get install python3 python3-pip g++ make`
* Fedora: `sudo dnf install python3 python3-pip gcc-c++ make`
* CentOS and RHEL: `sudo yum install python3 python3-pip gcc-c++ make`
* OpenSUSE: `sudo zypper install python3 python3-pip gcc-c++ make`
* Arch Linux, Manjaro: `sudo pacman -S python python-pip gcc make`

FreeBSD and OpenBSD users may also need to install `libexecinfo`.

#### macOS prerequisites

* Xcode Command Line Tools >= 11 for macOS
* Python 3.6, 3.7, 3.8, 3.9, or 3.10 (see note above)
* Python 3.6, 3.7, 3.8, 3.9, or 3.10 (see note above) with pip installed
Copy link
Copy Markdown
Contributor

@mscdex mscdex Oct 31, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and the package references above should be changed as well.

Copy link
Copy Markdown
Contributor Author

@PiotrRybak PiotrRybak Nov 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated this and moved the pip install packages to the end of package list (so it's slightly easier to remove them if someone doesn't want them).

It feels that it's better to keep them together than make the install instructions longer with 2 versions, but please let me know if you disagree.


macOS users can install the `Xcode Command Line Tools` by running
`xcode-select --install`. Alternatively, if you already have the full Xcode
Expand Down