Skip to content

Commit a20fdad

Browse files
committed
Swift: update README.md with IDE setup
1 parent 20a1281 commit a20fdad

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

swift/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,20 @@ bazel run //swift/codegen
3333

3434
to update generated files. This can be shortened to
3535
`bazel run codegen` if you are in the `swift` directory.
36+
37+
## IDE setup
38+
39+
### CLion and the native bazel plugin
40+
41+
You can use [CLion][1] with the official [IntelliJ Bazel plugin][2], creating the project from scratch with default
42+
options. This is known to have issues on non-Linux platforms.
43+
44+
[1]: https://www.jetbrains.com/clion/
45+
46+
[2]: https://ij.bazel.build/
47+
48+
### CMake project
49+
50+
The `CMakeLists.txt` file allows to load the Swift extractor as a CMake project, which allows integration into a wider
51+
variety of IDEs. Building with CMake also creates a `compile_commands.json` compilation database that can be picked up
52+
by even more IDEs. In particular, opening the `swift` directory in VSCode should work.

0 commit comments

Comments
 (0)