Skip to content

Commit b1a2933

Browse files
authored
Add images to README (#32)
1 parent 39a564a commit b1a2933

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,26 @@
44

55
If you're looking for a general use logger, this probably isn't the library for you!
66

7-
The design behind this logger was presented at ADCx 2023. Presentation [video](https://www.youtube.com/watch?v=4KFFMGTQIFM) and [slides](https://github.com/cjappl/Conference-Presentations/tree/main/Taming-Real-Time-Logging-ADCx-2023).
7+
The design behind this logger was presented at ADCx 2023.
8+
9+
[![ADCx rtlog presentation on youtube](data/PresentationScreenshot.png)](https://www.youtube.com/watch?v=4KFFMGTQIFM)
10+
11+
Slides:
12+
![Slide Title Page](data/SlideTitle.png)
813

914
## Features
1015

1116
- Ability to log messages of any type and size from the real-time thread
1217
- Statically allocated memory at compile time, no allocations in the real-time thread
13-
- Support for printf-style format specifiers (using [a version of the printf family](https://github.com/nothings/stb/blob/master/stb_sprintf.h) that doesn't hit the `localeconv` lock)
18+
- Support for printf-style format specifiers (using [a version of the printf family](https://github.com/nothings/stb/blob/master/stb_sprintf.h) that doesn't hit the `localeconv` lock) OR support for modern libfmt formatting.
1419
- Efficient thread-safe logging using a [lock free queue](https://github.com/cameron314/readerwriterqueue).
1520

1621
## Requirements
1722

1823
- A C++17 compatible compiler
1924
- The C++17 standard library
2025
- moodycamel::ReaderWriterQueue (will be downloaded via cmake if not provided)
21-
- stb's vsnprintf (will be downloaded via cmake if not provided)
26+
- stb's vsnprintf (will be downloaded via cmake if not provided) OR libfmt if cmake is run with the `RTSAN_USE_FMTLIB` option
2227

2328
## Installation via CMake
2429

data/PresentationScreenshot.png

897 KB
Loading

data/SlideTitle.png

304 KB
Loading

0 commit comments

Comments
 (0)