commit 15cf7e55cc1b988c5bfe2ebbd8af8808deb22e28 parent 4f835b9f04d8b0de8b69f3960480c19e62c95363 Author: Drew DeVault <sir@cmpwn.com> Date: Wed, 13 Apr 2022 17:15:50 +0200 log: add README Signed-off-by: Drew DeVault <sir@cmpwn.com> Diffstat:
| A | log/README | | | 8 | ++++++++ |
1 file changed, 8 insertions(+), 0 deletions(-)
diff --git a/log/README b/log/README @@ -0,0 +1,8 @@ +The log module provides a simple interface for application logging. The +[[logger]] interface provides an abstraction that users may implement for custom +logging logic. We provide a simple logger implementation that prefixes each line +with the current timestamp; to initialize such a logger see [[new]]. + +A global logger is also provided for simple applications to use, [[global]], +which is an instance of the standard logger that writes to [[os::stdout]] by +default. The user may configure a new global logger via [[setlogger]].