Skip to content

Add Bazel instructions to quick-start.md #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 1, 2025
Merged

Add Bazel instructions to quick-start.md #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed24df4
Add Bazel instructions to quick-start.md
lpingas Aug 30, 2025
694ab90
Update docs/en/guide/quick-start.md
lpingas Aug 30, 2025
597e031
fix code block
lpingas Aug 30, 2025
2d7de3a
Add chinese version.
16bit-ykiko Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/en/guide/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@ Note: This option only works when cmake's generator is set to makefile and ninja

### Bazel

TODO:
Bazel has no native support to generate a compilation database. The recommended solution is to use [bazel-compile-commands-extractor](https://github.com/hedronvision/bazel-compile-commands-extractor). After setting it up, you can generate `compile_commands.json` with:

```bash
bazel run @hedron_compile_commands//:refresh_all
```

### Visual Studio

Expand Down
6 changes: 5 additions & 1 deletion docs/zh/guide/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@ cmake -B build -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

### Bazel

TODO:
Bazel 不支持直接生成编译数据库，推荐使用 [bazel-compile-commands-extractor](https://github.com/hedronvision/bazel-compile-commands-extractor)。在安装好之后，你可以这样生成 `compile_commands.json`:

```bash
bazel run @hedron_compile_commands//:refresh_all
```

### Visual Studio

Expand Down