Skip to content

Commit

Permalink
Merge pull request #471 from ckormanyos/update_docs
Browse files Browse the repository at this point in the history
Update docs typos/tools/benchmarks
  • Loading branch information
ckormanyos authored Feb 3, 2024
2 parents bb6d8fa + 9cdddba commit da09157
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
17 changes: 7 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion ref_app/src/app/benchmark/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit da09157

Please sign in to comment.