Readme better now
This commit is contained in:
42
README.md
42
README.md
@@ -1,20 +1,39 @@
|
||||
jlog - Just Barely Logging
|
||||
# jlog - Just Barely Logging
|
||||
|
||||
jlog is a C++ library for logging to file, console, and event callbacks.
|
||||
|
||||
Features
|
||||
|
||||
* Lit
|
||||
* Based
|
||||
! [Static Badge](https://img.shields.io/badge/Lit-Based-%20)
|
||||
* Modern (C++20)
|
||||
* Static Library
|
||||
* Color Output
|
||||
* Logs to file AND console!
|
||||
* Idiomatic Event callback for hooking into your game engine gui!
|
||||
|
||||
Installation
|
||||
|
||||
Include this repository as a CPM dependency, and link against the library.
|
||||
(TODO: Show the relevant CMake script lines.)
|
||||
|
||||
```cmake
|
||||
CPMAddPackage(
|
||||
NAME Event
|
||||
URL https://git.redacted.cc/josh/Event/archive/Release-6.zip
|
||||
)
|
||||
# ...
|
||||
include_directories(${jlog_SOURCE_DIR}/include)
|
||||
# ...
|
||||
target_link_libraries(YourProgram ${PROJECT_NAME} jlog)
|
||||
|
||||
|
||||
```
|
||||
|
||||
Using jlog is straightforward:
|
||||
|
||||
cpp
|
||||
```cpp
|
||||
|
||||
#include "jlog.h"
|
||||
#include <jlog.h>
|
||||
|
||||
int main() {
|
||||
jlog::info("This is barely useful information.");
|
||||
@@ -23,11 +42,18 @@ int main() {
|
||||
return 0;
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
TODO
|
||||
|
||||
Custom Contexts: Allow users to specify custom logging contexts for better organization. Because sometimes you need to know if a log message came from "FunctionX" or "FunctionY".
|
||||
Custom Formats: Add support for custom log message formats. Because who said all log messages have to look the same?
|
||||
Documentation: Yeah, we should probably document this thing better. Coming soon™.
|
||||
* Custom Contexts: Allow users to specify custom logging contexts for better organization.
|
||||
* Disable & sort by context (other categories?)
|
||||
* Custom Formats: Add support for custom log message formats.
|
||||
* Documentation
|
||||
* Thread Safety
|
||||
* Memory Safety
|
||||
* Stream Support
|
||||
* Identify File, Line, Function name via macros (I hate macros!!!)
|
||||
|
||||
License
|
||||
|
||||
|
Reference in New Issue
Block a user