| 1 | <p align="center" id="lnm"> |
| 2 | <img src="/static/logobanner.png"/> |
| 3 | </p> |
| 4 | <p align="center"> |
| 5 | <i><b>(WIP)</b> A lightweight C logging library and parser for event-oriented logs.</i> |
| 6 | </p> |
| 7 | <p align="center"> |
| 8 | <img src="https://img.shields.io/github/license/joshuas3/lognestmonster?style=flat-square"/> |
| 9 | <img src="https://img.shields.io/badge/version-0.3.0-informational?style=flat-square"/> |
| 10 | <img src="https://img.shields.io/github/size/joshuas3/lognestmonster/src/c/lognestmonster.h?label=header%20size&style=flat-square"/> |
| 11 | <img src="https://img.shields.io/codacy/grade/15048b0c7728497394651e295d61746b/dev?logo=codacy&style=flat-square"/> |
| 12 | <a href="https://travis-ci.com/JoshuaS3/lognestmonster"> |
| 13 | <img src="https://img.shields.io/travis/joshuas3/lognestmonster/dev?logo=travis&style=flat-square"/> |
| 14 | </a> |
| 15 | <a href="https://github.com/JoshuaS3/lognestmonster/actions"> |
| 16 | <img src="https://img.shields.io/github/workflow/status/JoshuaS3/lognestmonster/C Header Unit Tests?label=C%20Header%20Unit%20Tests&logo=github&style=flat-square"/> |
| 17 | </a> |
| 18 | <p> |
| 19 |
|
| 20 | Lognestmonster is a general-purpose single-header C logging library that pertains a number of features: |
| 21 | - Nested/layer-based logging capabilities |
| 22 | - Event-oriented log compilation |
| 23 | - Multiple queues or outputs |
| 24 | - Full developer customizability on memory allocation |
| 25 | * Preprocessor handles to incorporate non-standard memory functions |
| 26 | - Full developer customizability on I/O redirection |
| 27 | * Generic filesystem log output |
| 28 | * End-to-end `stdout` and `stdin` piping, allowing data transfer over serial, socket, or anything else |
| 29 | - A binary format lighter than plaintext |
| 30 | - A feature-packed but comprehensive standalone deserializer/parser |
| 31 | * Interactive textual UI (ncurses) |
| 32 | * Logtree filtering/sorting and navigation |
| 33 | * Data operations such as binary to plaintext conversions and custom hooks on user-defined events |
| 34 | * Optional daemon for hook events |
| 35 | * Full developer customizability on data display, program controls, and hook operations |
| 36 |
|
| 37 | <i><b>(WIP)</b> Not yet meant for development or production use</i> |
| 38 |
|
| 39 | ## Copyright |
| 40 |
|
| 41 | This package is copyrighted by [Joshua 'joshuas3' Stockin](https://joshstock.in/) and licensed under the [MIT License](LICENSE). |
| 42 |
|
| 43 | A form of the following should be present in each major library source or header file. |
| 44 | ``` |
| 45 | lognestmonster Copyright (c) 2020 Joshua 'joshuas3' Stockin |
| 46 | <https://joshstock.in> |
| 47 | <https://github.com/JoshuaS3/lognestmonster> |
| 48 | This software is licensed under the MIT License. |
| 49 | ``` |
| 50 |
|
Index