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
Copy file name to clipboardExpand all lines: docs/contributing/framework-developer-guide.mdx
+83-14Lines changed: 83 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,12 +29,12 @@ cd neutralinojs
29
29
30
30
No need for separate compilers because Linux distributions usually have GNU C/C++ compilers installed already.
31
31
32
-
Install GTK, WebKit, other libraries with the following command.
32
+
Install GTK, WebKit, CMake, Ninja, other libraries with the following command.
33
33
34
34
##### Debian
35
35
36
36
```bash
37
-
sudo apt install libgtk-3-dev
37
+
sudo apt install libgtk-3-dev cmake ninja-build
38
38
```
39
39
40
40
```bash
@@ -54,20 +54,24 @@ sudo dnf install \
54
54
libgtk-3-dev \
55
55
libwebkit2gtk-4.1-0 \ # or libwebkit2gtk-4.0-37
56
56
libglib2.0-dev \
57
-
libxrandr-dev
57
+
libxrandr-dev \
58
+
cmake \
59
+
ninja-build
58
60
```
59
61
60
62
##### Arch
61
63
62
64
```bash
63
65
sudo pacman -S \
64
66
gtk3 \
65
-
webkit2gtk
67
+
webkit2gtk \
68
+
cmake \
69
+
ninja
66
70
```
67
71
68
72
#### Windows
69
73
70
-
Install the latest Visual Studio IDE with Windows SDK. The Neutralinojs compilation process will use the MSVC C++ compiler (aka `cl.exe`).
74
+
Install Visual Studio Build Tools or the Visual Studio IDE with the Windows SDK. The compilation process uses the MSVC C++ compiler (aka `cl.exe`) and requires [CMake](https://cmake.org/download/) (as the build system generator) and [Ninja](https://ninja-build.org/) (as the build executor).
71
75
72
76
:::info
73
77
How to activate Windows 10 SDK: While installing it in the Visual Studio Installer, go to tab Workloads, section "Desktop & Mobile" and select "Desktop development with C++". On the right in "Installation details" > "Desktop development with C++" > "Optional", make sure "Windows 10 SDK" is checked.
@@ -77,28 +81,93 @@ How to activate Windows 10 SDK: While installing it in the Visual Studio Install
77
81
78
82
Install Xcode Command Line Tools.
79
83
84
+
CMake and Ninja are also required and can be installed via Homebrew:
85
+
86
+
```bash
87
+
brew install cmake ninja
88
+
```
89
+
80
90
### Compile the Neutralinojs framework.
81
91
82
92
Run the following script in order to build the framework binaries.
83
93
84
-
#### Linux or macOS
94
+
1. Create a `build/` directory in the main repository.
95
+
96
+
<Tabs
97
+
defaultValue="Linux"
98
+
values={[
99
+
{label: 'Linux', value: 'Linux'},
100
+
{label: 'macOS', value: 'macOS'},
101
+
{label: 'Windows', value: 'Windows'},
102
+
]}>
103
+
<TabItemvalue="Linux">
85
104
86
105
```bash
87
-
python3 scripts/bz.py
106
+
mkdir build
88
107
```
89
108
90
-
#### Windows
109
+
</TabItem>
110
+
<TabItemvalue="macOS">
91
111
92
112
```bash
93
-
python scripts/bz.py
113
+
mkdir -p build
94
114
```
95
115
96
-
:::info
97
-
You need to have the [Python](https://www.python.org/downloads/) interpreter (version 3.x) installed to run this script.
Neutralinojs uses BuildZri C++ build automation tool to generate binaries on local development computers and
101
-
CI/CD servers. Read the [BuildZri documentation](https://codezri.org/docs/buildzri/intro) to learn more about CLI options and configuration.
170
+
This project uses CMake and Ninja to configure and build native binaries for local development and CI/CD environments. Developers can provide custom toolchains or platform-specific configurations to target additional platforms.
0 commit comments