diff --git a/README.md b/README.md index df3147a..3e368f1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,35 @@ # bao-rpi4-bench Project using Bao hypervisor with FreeRTOS+Linux running haRTStone benchmark. -Originally based on https://github.com/bao-project/bao-demos demo project but specialized for Raspberry Pi 4 +Originally based on [Bao Project's][bao] demo project but specialized for Raspberry Pi 4 running FreeRTOS and Linux. FreeRTOS executes the haRTSone benchmark to determine the performance and real time capabilities of FreeRTOS running under a vm environment. -# Usage +## Install Dependencies + +``` +sudo apt install build-essential bison flex git libssl-dev ninja-build \ + u-boot-tools pandoc +``` +## Download and setup the toolchain + +Download the latest bare-metal cross-compile toolchain for RPI4's architecture + +**aarch64-none-elf-** toolchain: [Arm Developer's][arm-toolchains]. + +Install the toolchain. Then, set the **CROSS_COMPILE** environment variable +with the reference toolchain prefix path: + +``` +export CROSS_COMPILE=/path/to/toolchain/install/dir/bin/your-toolchain-prefix- +``` + +## Clone Repo +``` git clone --recurse-submodules https://github.com/xX7/bao-rpi4-bench.git +``` + + + +[arm-toolchains]: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-a/downloads +[bao]: https://github.com/bao-project