Skip to content

Update docs #754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ckormanyos merged 2 commits into from
Jun 26, 2026
Merged

Update docs #754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c2d9fb
Update docs
ckormanyos Jun 26, 2026
ee73b84
Update example-docs godbolt links
ckormanyos Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions code_snippets/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ Real-Time-C++ - Code Snippets
<img src="https://img.shields.io/badge/try%20it%20on-godbolt-green" /></a>
</p>

These are the code snippets from the chapters of the book
C.M. Kormanyos,
[Real-Time C++](https://www.springer.com/de/book/9783662629956):
Efficient Object-Oriented
and Template Microcontroller Programming, Fourth Edition
(Springer, Heidelberg, 2021) ISBN 9783662629956.
These are the code snippets from the chapters
of the book C.M. Kormanyos, _Real-Time_ _C++:_ _Efficient_ _Object-Oriented_
_and_ _Template_ _Microcontroller_ _Programming_, _4_$^{th}$ _Edition_
and are made available for educational and exploratory use.

## Summary of the Code Snippets

Expand Down
6 changes: 3 additions & 3 deletions examples/chapter02_02/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## The LED program

<p align="center">
<a href="https://godbolt.org/z/fxWzb6h6f">
<a href="https://godbolt.org/z/zbcof9E94">
<img src="https://img.shields.io/badge/try%20it%20on-godbolt-green" alt="godbolt" />
</a>
</p>
Expand Down Expand Up @@ -160,7 +160,7 @@ such as:

## Try it at _godbolt_

Use the following [short link](https://godbolt.org/z/v5f45fMqq)
Use the following [short link](https://godbolt.org/z/zbcof9E94)
to [godbolt](https://godbolt.org) in order to further explore this program.

In the afore-mentioned link, the file [`led.cpp`](./led.cpp) is,
Expand All @@ -171,7 +171,7 @@ but not executed because there is no target hardware available.
### On the Metal: _Clear_ and _Set_ Bit

Consider the assembly output near the bottom of the page in the right-side tab
of the [short link](https://godbolt.org/z/v5f45fMqq)
of the [short link](https://godbolt.org/z/zbcof9E94)
to [godbolt](https://godbolt.org). Upon close investigation,
the bit-_clear_ and bit-_set_ opcodes (`cbi` and `sbi`)
can be recognized.
Expand Down
4 changes: 2 additions & 2 deletions examples/chapter03_02/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Integer Types Having Fixed Widths and Prime Numbers

<p align="center">
<a href="https://godbolt.org/z/dPbM7v4ff">
<a href="https://godbolt.org/z/Pa3WbG8h6">
<img src="https://img.shields.io/badge/try%20it%20on-godbolt-green" alt="godbolt" /></a>
</p>

Expand Down Expand Up @@ -89,7 +89,7 @@ A nifty little PC-based sieving program from the code snippets area helps to
[explore prime numbers](../../code_snippets/chapter03/chapter03_02-002a_explore_prime_numbers.cpp).

This code can be run in its entirety at the following
[short link](https://godbolt.org/z/dPbM7v4ff) to [godbolt](https://godbolt.org).
[short link](https://godbolt.org/z/Pa3WbG8h6) to [godbolt](https://godbolt.org).

## Prime Counting Function

Expand Down
4 changes: 2 additions & 2 deletions examples/chapter06_01/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## A CRC Benchmark

<p align="center">
<a href="https://godbolt.org/z/ssTK8TjWj">
<a href="https://godbolt.org/z/vvobo4Pnq">
<img src="https://img.shields.io/badge/try%20it%20on-godbolt-green" alt="godbolt" /></a>
</p>

Expand Down Expand Up @@ -91,7 +91,7 @@ The expected result of the CRC-32/MPEG-2 of these
data bytes is `0x0376'E6E7`.

This code can be run in its entirety at the following
[short link](https://godbolt.org/z/ssTK8TjWj) to [godbolt](https://godbolt.org).
[short link](https://godbolt.org/z/vvobo4Pnq) to [godbolt](https://godbolt.org).

The application benchmark task `app::benchmark::task_func`
computes the CRC-32/MPEG-2. The computation is run to completion
Expand Down
4 changes: 2 additions & 2 deletions examples/chapter10_08/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## External SPI RAM and Computing 10,001 Digits of Pi

<p align="center">
<a href="https://godbolt.org/z/EMx88ocxn">
<a href="https://godbolt.org/z/cr7MxKsK3">
<img src="https://img.shields.io/badge/try%20it%20on-godbolt-green" alt="godbolt" /></a>
</p>

Expand Down Expand Up @@ -66,7 +66,7 @@ A similar implementation of the Pi Spigot program has been setup
at [godbolt](https://godbolt.org), where it can be compiled and executed.
This setup computes $10,001$ decimal digits of $\pi$.

Use the following [short link](https://godbolt.org/z/EMx88ocxn)
Use the following [short link](https://godbolt.org/z/cr7MxKsK3)
to further explore this program.

## 8-Bit MCU Adaptions
Expand Down
2 changes: 1 addition & 1 deletion examples/chapter16_08/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ $$
\left(\frac{2}{3}\right)~{\approx}~\frac{1}{24}\text{,}
$$

which is around $4\%$.
which is around $4\\%$.

Sect. 16.8 in the book runs through
the related, intriguing mathematics in great detail.
Expand Down
15 changes: 6 additions & 9 deletions examples/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,13 @@
<img src="https://github.com/ckormanyos/real-time-cpp/actions/workflows/real-time-cpp-examples.yml/badge.svg" alt="Build Examples"></a>
<a href="https://github.com/ckormanyos/real-time-cpp/blob/master/LICENSE_1_0.txt">
<img src="https://img.shields.io/badge/license-BSL%201.0-blue.svg" alt="Boost Software License 1.0"></a>
<a href="https://godbolt.org/z/fxWzb6h6f">
<a href="https://godbolt.org/z/zbcof9E94">
<img src="https://img.shields.io/badge/try%20it%20on-godbolt-green" alt="godbolt"></a>
</p>

These examples are motivated by the book
C.M. Kormanyos,
[Real-Time C++](https://www.springer.com/de/book/9783662629956):
Efficient Object-Oriented
and Template Microcontroller Programming, Fourth Edition
(Springer, Heidelberg, 2021) ISBN 9783662629956.
These examples are motivated by the book C.M. Kormanyos, _Real-Time_ _C++:_
_Efficient_ _Object-Oriented_ _and_ _Template_ _Microcontroller_ _Programming_, _4_$^{th}$ _Edition_
and are made available for educational and exploratory use.

The first couple of example projects can use the ARDUINO board directly
and non-modified. Examples from the later chapters in the book do, however,
Expand Down Expand Up @@ -140,11 +137,11 @@ in each individual example directory.
## Try it at _godbolt_

<p align="center">
<a href="https://godbolt.org/z/fxWzb6h6f">
<a href="https://godbolt.org/z/zbcof9E94">
<img src="https://img.shields.io/badge/try%20it%20on-godbolt-green" alt="godbolt"></a>
</p>

Use this [short link](https://godbolt.org/z/fxWzb6h6f)
Use this [short link](https://godbolt.org/z/zbcof9E94)
to [godbolt](https://godbolt.org) in order to further explore
Example [chapter02_02](https://github.com/ckormanyos/real-time-cpp/tree/master/examples/chapter02_02)
(the LED program). In the link, the main source file of the example
Expand Down
Loading