Ladybird/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-06-08 05:27:14 +09:00
Code Activity

Documentation: Update build instructions to remove -GXcode suggestion

Browse source 
Also some other assorted docs cleanup.
This commit is contained in:
Andrew Kaster 2025-03-19 16:46:06 -06:00 • committed by Tim Flynn
parent 2f6de5d9ac
commit ddcd48d12e
Notes: github-actions[bot] 2025-03-20 00:43:11 +00:00
1 changed files with 11 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Documentation/BuildInstructionsLadybird.md
View file

@ -129,14 +129,14 @@ cmake -GNinja -BBuild/release
Finally, run `ninja` (or the generator you're using) to start the build: Finally, run `ninja` (or the generator you're using) to start the build:
``` ```
ninja -CBuild/release ninja -C Build/release
``` ```
For more information, see [Custom CMake build directory](#custom-cmake-build-directory) and [Running manually](#running-manually). For more information, see [Custom CMake build directory](#custom-cmake-build-directory) and [Running manually](#running-manually).
### macOS: ### macOS:
Xcode 14 versions before 14.3 might crash while building ladybird. Xcode 14.3 or clang from homebrew may be required to successfully build ladybird. Xcode 15 or clang from homebrew is required to successfully build ladybird.
``` ```
xcode-select --install xcode-select --install
@ -214,7 +214,7 @@ The simplest way to build and run ladybird is via the ladybird.sh script:
```bash ```bash
# From /path/to/ladybird # From /path/to/ladybird
./Meta/ladybird.sh run ladybird ./Meta/ladybird.sh run
``` ```
On macOS, to build using clang from homebrew: On macOS, to build using clang from homebrew:
@ -231,11 +231,14 @@ The above commands will build a Release version of Ladybird. To instead build a
`Meta/ladybird.sh` script with the value of the `BUILD_PRESET` environment variable set to `Debug`, like this: `Meta/ladybird.sh` script with the value of the `BUILD_PRESET` environment variable set to `Debug`, like this:
```bash ```bash
BUILD_PRESET=Debug ./Meta/ladybird.sh run ladybird BUILD_PRESET=Debug ./Meta/ladybird.sh run
``` ```
Note that debug symbols are available in both Release and Debug builds. Note that debug symbols are available in both Release and Debug builds.
If you want to run other applications, such as the headless-browser, the JS REPL, or the WebAssembly REPL, specify an
executable with `./Meta/ladybird.sh run <executable_name>`.
### The User Interfaces ### The User Interfaces
Ladybird will be built with one of the following browser frontends, depending on the platform: Ladybird will be built with one of the following browser frontends, depending on the platform:
@ -305,9 +308,9 @@ a suitable C++ compiler (g++ >= 13, clang >= 14, Apple Clang >= 14.3) via the CM
CMAKE_C_COMPILER cmake options. CMAKE_C_COMPILER cmake options.
``` ```
cmake -GNinja -B MyBuildDir cmake --preset default -B MyBuildDir
# optionally, add -DCMAKE_CXX_COMPILER=<suitable compiler> -DCMAKE_C_COMPILER=<matching c compiler> # optionally, add -DCMAKE_CXX_COMPILER=<suitable compiler> -DCMAKE_C_COMPILER=<matching c compiler>
cmake --build MyBuildDir cmake --build --preset default MyBuildDir
ninja -C MyBuildDir run-ladybird ninja -C MyBuildDir run-ladybird
``` ```
@ -367,15 +370,8 @@ Simply run the `ladybird.sh` script as normal, and then make sure to codesign th
Now you can open the Instruments app and point it to the Ladybird app bundle. Now you can open the Instruments app and point it to the Ladybird app bundle.
If you want to use Xcode itself for debugging, you will need to generate an Xcode project. Building the project with Xcode is not supported. The Xcode project generated by CMake does not properly execute custom
The `ladybird.sh` build script does not know how to generate Xcode projects, so creating the project must be done manually. targets, and does not handle all target names in the project.
```
cmake -GXcode -B Build/release
```
After generating an Xcode project into the specified build directory, you can open `ladybird.xcodeproj` in Xcode. The project has a ton of targets, many of which are generated code.
The only target that needs a scheme is the ladybird app bundle.
### Building on OpenIndiana ### Building on OpenIndiana