Skip to content

Updated Linux building instructions. #1624

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

Open
bkaradzic-microsoft wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Updated Linux building instructions. #1624

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1554ccb
Updated Linux building instructions.
bkaradzic Mar 10, 2026
c1e3237
Fix misleading "Clang-9 toolchain" label in Linux build instructions …
Copilot Mar 10, 2026
0b71f3b
Fix inconsistent apt usage and duplicate JSC package in Linux build i…
Copilot Mar 10, 2026
07ad0fa
Fix invalid CMake command in Linux building instructions (#1625)
Copilot Mar 10, 2026
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
10 changes: 5 additions & 5 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,10 +276,10 @@ _Follow the steps from [All Development Platforms](#all-development-platforms) b

The minimal requirement target is an OpenGL 3.3 compatible GPU. Clang 9+ or GCC 9+ are required for building.

First step is to install packages mandatory for building. For example, with Clang-9 toolchain:
First step is to install packages mandatory for building. For example, with a GCC toolchain:

```
sudo apt-get install libgl1-mesa-dev libcurl4-openssl-dev clang-9 libc++-9-dev libc++abi-9-dev lld-9 ninja-build
sudo apt-get install libgl1-mesa-dev x11proto-core-dev libx11-dev libcurl4-openssl-dev g++ cmake ninja-build npm
Copy link
Contributor

@bghgary bghgary Mar 10, 2026

Choose a reason for hiding this comment

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

I don't think we should add npm here. Depending on how people use npm, it may be installed differently. Same goes for cmake. They are already requirements listed in the All Development Platforms section.

Copy link
Contributor

@bghgary bghgary Mar 10, 2026

Choose a reason for hiding this comment

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

Also, why switch from CLang to GCC?

Copy link
Contributor Author

@bkaradzic-microsoft bkaradzic-microsoft Mar 10, 2026

Choose a reason for hiding this comment

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

Since clang is not really required and GCC might be already installed.

Copy link
Contributor Author

@bkaradzic-microsoft bkaradzic-microsoft Mar 10, 2026

Choose a reason for hiding this comment

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

The whole command line gets you into the state where you can build just build. If cmake or npm is not there, something might fail.

Copy link
Contributor

@bghgary bghgary Mar 16, 2026

Choose a reason for hiding this comment

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

Yes, but many people don't install cmake or npm using apt, so this may cause problems for them.

```

Depending on the JavaScript engine you want to use, you will have to install the package accordingly:
Expand All @@ -295,7 +295,7 @@ sudo apt-get install libjavascriptcoregtk-4.1-dev
Then, run cmake targetting a Ninja make file:

```
cmake -G Ninja -D JAVASCRIPTCORE_LIBRARY=/usr/lib/x86_64-linux-gnu/libjavascriptcoregtk-4.1.so -D NAPI_JAVASCRIPT_ENGINE=JavaScriptCore
cmake -B build/linux -G Ninja -D NAPI_JAVASCRIPT_ENGINE=JavaScriptCore
Copy link
Contributor

@bghgary bghgary Mar 10, 2026

Choose a reason for hiding this comment

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

Suggested change
cmake -B build/linux -G Ninja -D NAPI_JAVASCRIPT_ENGINE=JavaScriptCore
cmake -B build/linux -G Ninja

JavaScriptCore is also the default now.

```

### V8
Expand All @@ -309,13 +309,13 @@ sudo apt-get install libv8-dev
Then, run cmake targetting a Ninja make file:

```
cmake -G Ninja -D NAPI_JAVASCRIPT_ENGINE=V8
cmake -B build/linux -G Ninja -D NAPI_JAVASCRIPT_ENGINE=V8
```

And finally, for any JavaScript engine, run a build:

```
ninja
cmake --build build/linux
```

You can switch compiler between GCC and Clang by defining shell variables.
Expand Down
Loading