Skip to content

Commit ddcd48d

Browse files
ADKastertrflynn89
authored andcommitted
Documentation: Update build instructions to remove -GXcode suggestion
Also some other assorted docs cleanup.
1 parent 2f6de5d commit ddcd48d

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

Documentation/BuildInstructionsLadybird.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -129,14 +129,14 @@ cmake -GNinja -BBuild/release
129129
Finally, run `ninja` (or the generator you're using) to start the build:
130130

131131
```
132-
ninja -CBuild/release
132+
ninja -C Build/release
133133
```
134134

135135
For more information, see [Custom CMake build directory](#custom-cmake-build-directory) and [Running manually](#running-manually).
136136

137137
### macOS:
138138

139-
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.
139+
Xcode 15 or clang from homebrew is required to successfully build ladybird.
140140

141141
```
142142
xcode-select --install
@@ -214,7 +214,7 @@ The simplest way to build and run ladybird is via the ladybird.sh script:
214214

215215
```bash
216216
# From /path/to/ladybird
217-
./Meta/ladybird.sh run ladybird
217+
./Meta/ladybird.sh run
218218
```
219219

220220
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
231231
`Meta/ladybird.sh` script with the value of the `BUILD_PRESET` environment variable set to `Debug`, like this:
232232

233233
```bash
234-
BUILD_PRESET=Debug ./Meta/ladybird.sh run ladybird
234+
BUILD_PRESET=Debug ./Meta/ladybird.sh run
235235
```
236236

237237
Note that debug symbols are available in both Release and Debug builds.
238238

239+
If you want to run other applications, such as the headless-browser, the JS REPL, or the WebAssembly REPL, specify an
240+
executable with `./Meta/ladybird.sh run <executable_name>`.
241+
239242
### The User Interfaces
240243

241244
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
305308
CMAKE_C_COMPILER cmake options.
306309

307310
```
308-
cmake -GNinja -B MyBuildDir
311+
cmake --preset default -B MyBuildDir
309312
# optionally, add -DCMAKE_CXX_COMPILER=<suitable compiler> -DCMAKE_C_COMPILER=<matching c compiler>
310-
cmake --build MyBuildDir
313+
cmake --build --preset default MyBuildDir
311314
ninja -C MyBuildDir run-ladybird
312315
```
313316

@@ -367,15 +370,8 @@ Simply run the `ladybird.sh` script as normal, and then make sure to codesign th
367370

368371
Now you can open the Instruments app and point it to the Ladybird app bundle.
369372

370-
If you want to use Xcode itself for debugging, you will need to generate an Xcode project.
371-
The `ladybird.sh` build script does not know how to generate Xcode projects, so creating the project must be done manually.
372-
373-
```
374-
cmake -GXcode -B Build/release
375-
```
376-
377-
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.
378-
The only target that needs a scheme is the ladybird app bundle.
373+
Building the project with Xcode is not supported. The Xcode project generated by CMake does not properly execute custom
374+
targets, and does not handle all target names in the project.
379375

380376
### Building on OpenIndiana
381377

0 commit comments

Comments
 (0)