From 9cdddbab8291fdcd7e98184f5156510e4d22176b Mon Sep 17 00:00:00 2001 From: Christopher Kormanyos Date: Sat, 3 Feb 2024 13:57:36 +0100 Subject: [PATCH] Update docs typos/tools/benchmarks --- readme.md | 17 +++++++---------- ref_app/src/app/benchmark/readme.md | 4 +++- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/readme.md b/readme.md index 8e02dffdc..6c4e8b8d8 100644 --- a/readme.md +++ b/readme.md @@ -519,17 +519,14 @@ The build status badges represent the state of the nightly CI builds and tests. ## Modern `avr-gcc` Toolchain The repo [avr-gcc-build](https://github.com/ckormanyos/avr-gcc-build) -builds _very_ up-to-date `avr-gcc` toolchains. -Shell and YAML scripts build `avr-gcc` -directly from source on GHA runner(s). The Workflow-Run(s) -build `avr-gcc` from up-to-date releases such as `12.3.0` or other -modern branches like `trunk` or `releases/gcc-13`. -An `x86_64-linux-gnu`-build on `*nix` is provided. -There is also a dependency-free, statically-linked `x86_64-w64-mingw32`-build -intended for `Win*`. +builds up-to-date `avr-gcc` toolchains for `x86_64-linux-gnu` and `x86_64-w64-mingw32`. +Shell and YAML scripts build `avr-gcc` directly from source on GHA runner(s). +In addition, occasional GitHub-releases provide pre-built +`avr-gcc` toolchains for `x86_64-linux-gnu` and `x86_64-w64-mingw32`. + This repo is a great place to learn how to build your own `avr-gcc` toolchain -from source since the straightforward shell and YAML scripts are easy to use -or adapt. +from source. The straightforward, well-described shell and YAML scripts +are easy to understand, use or adapt. ## GNU/GCC Compilers diff --git a/ref_app/src/app/benchmark/readme.md b/ref_app/src/app/benchmark/readme.md index b21aa504f..7eb1841be 100644 --- a/ref_app/src/app/benchmark/readme.md +++ b/ref_app/src/app/benchmark/readme.md @@ -24,7 +24,9 @@ Executing the benchmarks is straightforward. Select the desired benchmark and activate its corresponding flag in -[app_benchmark.h](https://github.com/ckormanyos/real-time-cpp/blob/master/ref_app/src/app/benchmark/app_benchmark_none.h) +[app_benchmark.h](https://github.com/ckormanyos/real-time-cpp/blob/master/ref_app/src/app/benchmark/app_benchmark.h). +In particular, `#define` the flag `APP_BENCHMARK_TYPE` to be one of the pre-defined benchmark types +(typically done by sinply un-commenting one of the easily-found relevant lines. Compile the reference application and run on the target. The benchmark timing will be reflected on microcontroller's corresponding benchmark port pin (in its MCAL).