diff --git a/docs/project/building-windows.md b/docs/project/building-windows.md index bae0bc14df214e..44ef81b70ee7cc 100644 --- a/docs/project/building-windows.md +++ b/docs/project/building-windows.md @@ -104,10 +104,10 @@ If you intend on building WebKit locally (optional), you should install these pa {% /codetabs %} -From here on out, it is **expected you use a PowerShell Terminal with `.\scripts\env.ps1` sourced**. This script is available in the Bun repository and can be loaded by executing it: +From here on out, it is **expected you use a PowerShell Terminal with `.\scripts\vs-shell.ps1` sourced**. This script is available in the Bun repository and can be loaded by executing it: ```ps1 -> .\scripts\env.ps1 +> .\scripts\vs-shell.ps1 ``` To verify, you can check for an MSVC-only command line such as `mt.exe` @@ -117,49 +117,41 @@ To verify, you can check for an MSVC-only command line such as `mt.exe` ``` {% callout %} -It is not recommended to install `ninja` / `cmake` into your global path, because you may run into a situation where you try to build bun without .\scripts\env.ps1 sourced. +It is not recommended to install `ninja` / `cmake` into your global path, because you may run into a situation where you try to build bun without .\scripts\vs-shell.ps1 sourced. {% /callout %} ## Building ```ps1 -> bun install +> bun run build -> .\scripts\env.ps1 -> .\scripts\update-submodules.ps1 # this syncs git submodule state -> .\scripts\all-dependencies.ps1 # this builds all dependencies -> .\scripts\make-old-js.ps1 # runs some old code generators - -# Configure build environment -> cmake -Bbuild -GNinja -DCMAKE_BUILD_TYPE=Debug - -# Build bun -> ninja -Cbuild +# after the initialize `bun run build` you can use the following to build +> ninja -Cbuild/debug ``` -If this was successful, you should have a `bun-debug.exe` in the `build` folder. +If this was successful, you should have a `bun-debug.exe` in the `build/debug` folder. ```ps1 -> .\build\bun-debug.exe --revision +> .\build\debug\bun-debug.exe --revision ``` -You should add this to `$Env:PATH`. The simplest way to do so is to open the start menu, type "Path", and then navigate the environment variables menu to add `C:\.....\bun\build` to the user environment variable `PATH`. You should then restart your editor (if it does not update still, log out and log back in). +You should add this to `$Env:PATH`. The simplest way to do so is to open the start menu, type "Path", and then navigate the environment variables menu to add `C:\.....\bun\build\debug` to the user environment variable `PATH`. You should then restart your editor (if it does not update still, log out and log back in). ## Extra paths -- WebKit is extracted to `build/bun-webkit` -- Zig is extracted to `.cache/zig/zig.exe` +- WebKit is extracted to `build/debug/cache/webkit/` +- Zig is extracted to `build/debug/cache/zig/bin/zig.exe` ## Tests -You can run the test suite either using `bun test`, or by using the wrapper script `packages\bun-internal-test`. The internal test package is a wrapper cli to run every test file in a separate instance of bun.exe, to prevent a crash in the test runner from stopping the entire suite. +You can run the test suite either using `bun test `, or by using the wrapper script `packages\bun-internal-test`. The internal test package is a wrapper cli to run every test file in a separate instance of bun.exe, to prevent a crash in the test runner from stopping the entire suite. ```ps1 # Setup > bun i --cwd packages\bun-internal-test # Run the entire test suite with reporter -# the package.json script "test" uses "build/bun-debug.exe" by default +# the package.json script "test" uses "build/debug/bun-debug.exe" by default > bun run test # Run an individual test file: