Imbus/neptune
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Readme: include a note about bear, example included

Browse source
This commit is contained in:
Imbus 2025-09-02 02:04:44 +02:00
parent 59fda90b89
commit d15ab5cc04
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -23,7 +23,9 @@ root
### Quick Start ### Quick Start
On a linux machine, make sure that you have `make` and `curl` in path. The rest 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 ```sh
make get_toolchain # Dont worry, is will land locally inside project directory make get_toolchain # Dont worry, is will land locally inside project directory
@ -31,6 +33,12 @@ make -j$(nproc)
make qemu 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: The project can be cleaned with:
```sh ```sh
make clean # Wipes .o, .d, .elf make clean # Wipes .o, .d, .elf