diff --git a/README.md b/README.md index 52fd5e1..c2a1e05 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,9 @@ root ### Quick Start On a linux machine, make sure that you have `make` and `curl` in path. The rest -of the tooling (gcc, qemu) will be handled by the build system. +of the tooling (gcc, qemu) will be handled by the build system. For extra convenience, +you could also use `bear` for generating "compile_commands.json". This is useful for helping +clangd pick up the correct paths, and will result in better in-editor diagnostics and warnings. ```sh make get_toolchain # Dont worry, is will land locally inside project directory @@ -31,6 +33,12 @@ make -j$(nproc) make qemu ``` +To generate "compile_commands.json": +```sh +make clean # To get a full build +bear -- make -j$(nproc) +``` + The project can be cleaned with: ```sh make clean # Wipes .o, .d, .elf