From e1cd7e510ec0a3b2f6fa44c14426bb74db7e2a81 Mon Sep 17 00:00:00 2001 From: Mathias Date: Wed, 2 Oct 2024 22:44:54 +0200 Subject: [PATCH] Update CONTRIBUTING.md, fix #14225 (#14303) --- CONTRIBUTING.md | 24 ++++-------------------- 1 file changed, 4 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d3dbb0fd2..d5e00b342e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -116,35 +116,19 @@ $ export PATH="$PATH:/usr/lib/llvm16/bin" ## Building Bun -After cloning the repository, run the following command to run the first build. This may take a while as it will clone submodules and build dependencies. - -```bash -$ bun setup -``` - -The binary will be located at `./build/bun-debug`. It is recommended to add this to your `$PATH`. To verify the build worked, let's print the version number on the development build of Bun. - -```bash -$ build/bun-debug --version -x.y.z_debug -``` - -To rebuild, you can invoke `bun run build` +After cloning the repository, run the following command to build. This may take a while as it will clone submodules and build dependencies. ```bash $ bun run build ``` -These two scripts, `setup` and `build`, are aliases to do roughly the following: +The binary will be located at `./build/debug/bun-debug`. It is recommended to add this to your `$PATH`. To verify the build worked, let's print the version number on the development build of Bun. ```bash -$ ./scripts/setup.sh -$ cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug -$ ninja -C build # 'bun run build' runs just this +$ build/debug/bun-debug --version +x.y.z_debug ``` -Advanced users can pass CMake flags to customize the build. - ## VSCode VSCode is the recommended IDE for working on Bun, as it has been configured. Once opening, you can run `Extensions: Show Recommended Extensions` to install the recommended extensions for Zig and C++. ZLS is automatically configured.