Updated README. New demo image. Fixed typo in demo.

This commit is contained in:
2024-08-13 16:01:38 -04:00
parent 7b25a097cd
commit d8439efcaf
3 changed files with 8 additions and 12 deletions

View File

@@ -35,17 +35,15 @@ Using jlog is straightforward:
```cpp ```cpp
#include <jlog.h> #include <jlog/jlog.hpp>
int main() { int main() {
LOGLEVEL(jlog::severity::debug); // <- see jlog::severity for full list of LogTrace levels jlog::info("This is barely useful information.");
jlog::debug("Debugging Information");
info("This is barely useful information."); jlog::verbose("Yadda Yadda Yadda");
debug("Debugging Information"); jlog::warning("Slight miscalculation!");
verbose("Yadda Yadda Yadda"); jlog::error("Oops, something went wrong.");
warning("Slight miscalculation!"); jlog::fatal("Unrecoverable Error!!!");
error("Oops, something went wrong.");
fatal("Unrecoverable Error!!!");
return 0; return 0;
} }
@@ -58,8 +56,6 @@ int main() {
## TODO ## TODO
* Custom Contexts: Allow users to specify custom logging contexts for better organization.
* Disable & sort by context (other categories?)
* Documentation * Documentation
* Thread Safety * Thread Safety
* Memory Safety * Memory Safety

BIN
img.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 152 KiB

View File

@@ -15,7 +15,7 @@ int main()
jlog::Logger demo{"demo", Colors::Pinks::DeepPink}; jlog::Logger demo{"demo", Colors::Pinks::DeepPink};
demo.SetTraceback(false); demo.SetTraceback(false);
demo(std::format("{}\n>\t{}\n>\t{}", demo(std::format("{}\n>\t{}\n>\t{}",
"Custom loggers such as this on can be easily created", "Custom loggers such as this one can be easily created",
"jlog::Logger demo{\"demo\", Colors::Pinks::DeepPink};", "demo.SetTraceback(false);")); "jlog::Logger demo{\"demo\", Colors::Pinks::DeepPink};", "demo.SetTraceback(false);"));
// "Custom loggers such as this one can be easily created.")); // "Custom loggers such as this one can be easily created."));