yves-biener/zlog
1
0
Fork 0
Code Issues Pull Requests Actions Activity

doc: update README
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 56s
Details

Browse Source
This commit is contained in:
Yves Biener
2025-02-21 23:22:14 +01:00
parent 04795091a8
commit dd98e63bcb
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -2,6 +2,9 @@
Standard Library log wrapper. `zlog` provides adjusted `std.log` output and a pretty print function for easy overwriting of user defined types (`struct`, `enum`, `union` and `vector`). Standard Library log wrapper. `zlog` provides adjusted `std.log` output and a pretty print function for easy overwriting of user defined types (`struct`, `enum`, `union` and `vector`).
> [!CAUTION]
> Only builds using the zig master version are tested to work.
## Usage ## Usage
The following snippet shows an example usage of `zlog` to change the default log format and add pretty printing to both user defined types (`Options` and `Struct`): The following snippet shows an example usage of `zlog` to change the default log format and add pretty printing to both user defined types (`Options` and `Struct`):
@@ -89,7 +92,9 @@ This will result in the following output:
For more details about the output customization see the configuration options of the `zlog` module. Following options are available: For more details about the output customization see the configuration options of the `zlog` module. Following options are available:
- _timestamp_ (default: `true`): Prepend the current timestamp before each log message. - _timestamp_ (default: `true`): Prepend the current timestamp before each log message.
- _stderr_ (default: `true`): Print log messages to stderr. **NOTE**: Currently not working as log output is not appended and only the last log message will be in the resulting log file! This is a not-yet-implemented feature of the standard library of zig! See this [issue](https://github.com/ziglang/zig/issues/14375) for more details. - _stderr_ (default: `true`): Print log messages to stderr.
> [!CAUTION]
> Currently not working as log output is not appended and only the last log message will be in the resulting log file! This is a not-yet-implemented feature of the standard library of zig! See this [issue](https://github.com/ziglang/zig/issues/14375) for more details.
## Tips ## Tips