BadgerOS is the operating system currently in development for the upcoming WHY2025 badge. The goal is the allow future badge users to get both the performance that native apps can afford as well as the portability made possible by this OS.
We are an open-source project, so we can always use more hands! If you're new to this project and want to help, message us:
- RobotMan2412 on telegram
- Badge.team telegram group
After that, see Project structure for reference about how this project works.
To be able build the project, we need to install tools and a compiler required for RISCV architecture.
sudo apt install -y gcc-riscv64-linux-gnu build-essential git picocom cmake python3Above command installs all the tools and compiler listed below.
- git
- build-essential
- cmake
- python3
- picocom
- A RISC-V toolchain, one of:
- BadgerOS buildroot, preferably riscv64
gcc-riscv64-linux-gnu(ubuntu) /riscv64-gnu-toolchain-glibc-bin(arch)
If you don't know what this is, you don't need this. All of:
- mtools
- swig
- gptfdisk
The build system is based on Makefiles and CMake. The following commands can be used to perform relevant actions:
To select target platform, choose one of:
make config(manual configuration)make hh24_defconfig(HackerHotel 2024 badge)make why2025_defconfig(WHY2025 badge)make unmatched_defconfig(RISC-V PC port)
Navigate to the project directory: cd /path/to/BadgerOS
1. To build, run: make build
2. To remove build files, run: make clean
3. To flash to an ESP, run: make flash
4. To open picocom, run: make monitor
5. To build, flash and open picocom, run: make or make all
To check code style: make clang-format-check (code formatting) and make clang-tidy-check (programming guidelines)
Build artifacts will be put into the kernel/firmware folder once the project was successfully built.
