Readme better now
This commit is contained in:
115
README.md
115
README.md
@@ -1,60 +1,14 @@
|
||||
jlog - Just Barely Logging
|
||||
Description
|
||||
|
||||
Welcome to jlog, the logging library that barely logs but does it with style. If you're tired of those bloated, feature-rich logging libraries that come with more bells and whistles than a clown car at a circus, then jlog is the lightweight, minimalist solution you've been looking for. With jlog, we've stripped away all the unnecessary fluff, leaving you with just the bare essentials for logging.
|
||||
Features
|
||||
|
||||
Logging: Yes, we do that. Sort of.
|
||||
Output: Logs messages to stdout because, let's be honest, who needs file logging?
|
||||
Levels: We have two levels - "Info" and "Error." Because life isn't complicated enough.
|
||||
* Lit
|
||||
* Based
|
||||
|
||||
Installation
|
||||
|
||||
To install jlog, simply copy the jlog.h header file to your project and include it wherever you want to barely log things. That's it. Seriously.
|
||||
Usage
|
||||
|
||||
Using jlog is as simple as 1-2-3:
|
||||
|
||||
cpp
|
||||
|
||||
#include "jlog.h"
|
||||
|
||||
int main() {
|
||||
jlog_info("This is barely useful information.");
|
||||
jlog_error("Something went wrong. Surprise!");
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
License
|
||||
|
||||
jlog is licensed under the "Do whatever you want with it, just don't blame us if it breaks something" license. Enjoy!
|
||||
Contributing
|
||||
|
||||
We're not actively seeking contributions because, honestly, what else is there to add? But if you really feel inclined to contribute, go ahead and submit a pull request. Just don't expect much enthusiasm from us.
|
||||
Disclaimer
|
||||
|
||||
Warning: Using jlog may result in feelings of inadequacy compared to other logging libraries. Side effects may include frustration, regret, and an overwhelming desire to switch to a more fully-featured solution. Use at your own risk.
|
||||
|
||||
Feel free to adjust and embellish as needed!
|
||||
little more realistic, add a TODO with custom contexts. custom formats, documentation
|
||||
ChatGPT
|
||||
|
||||
Absolutely, let's add a bit more practicality while keeping the tongue-in-cheek tone:
|
||||
jlog - Just Barely Logging
|
||||
Description
|
||||
|
||||
Welcome to jlog, the logging library that does the bare minimum, but hey, it's something. If you're tired of bloated logging libraries with more features than you'll ever need, then jlog might just be your cup of tea. With jlog, we keep things simple and to the point, because who has time for complexity?
|
||||
Features
|
||||
|
||||
Logging: Yes, we log things. Sometimes.
|
||||
Output: Logs messages to stdout because we like to keep things visible.
|
||||
Levels: We've got two: "Info" for the mundane, and "Error" for when things go south.
|
||||
|
||||
Installation
|
||||
|
||||
To install jlog, simply copy the jlog.h header file to your project and include it wherever you want to do some bare minimum logging. It's so simple, you'll wonder why you're reading installation instructions in the first place.
|
||||
Usage
|
||||
Include this repository as a CPM dependency, and link against the library.
|
||||
(TODO: Show the relevant CMake script lines.)
|
||||
|
||||
Using jlog is straightforward:
|
||||
|
||||
@@ -63,8 +17,8 @@ cpp
|
||||
#include "jlog.h"
|
||||
|
||||
int main() {
|
||||
jlog_info("This is barely useful information.");
|
||||
jlog_error("Oops, something went wrong.");
|
||||
jlog::info("This is barely useful information.");
|
||||
jlog::error("Oops, something went wrong.");
|
||||
|
||||
return 0;
|
||||
}
|
||||
@@ -77,59 +31,8 @@ TODO
|
||||
|
||||
License
|
||||
|
||||
jlog is licensed under the "Do whatever you want with it, just don't blame us if it breaks something" license. Enjoy responsibly!
|
||||
This software is written and developed by Josh O'Leary @ Redacted Software 2024. This work is dedicated to the public domain.
|
||||
|
||||
Contributing
|
||||
|
||||
While we're not actively seeking contributions, if you have a burning desire to improve jlog, feel free to submit a pull request. Just keep it simple, okay?
|
||||
Disclaimer
|
||||
|
||||
Warning: Using jlog may result in a strange mixture of satisfaction for its simplicity and frustration for its lack of features. Side effects may include contemplating whether to switch to a more fully-featured logging solution. Use at your own risk.
|
||||
|
||||
Hope this strikes the right balance between realism and humor!
|
||||
logs to both FILE and CONSOLE!!!!
|
||||
ChatGPT
|
||||
|
||||
Got it, let's update the README to reflect that:
|
||||
jlog - Just Barely Logging
|
||||
Description
|
||||
|
||||
Welcome to jlog, the logging library that does the bare minimum, but with a twist - it logs to both FILE and CONSOLE! If you're tired of bloated logging libraries with more features than you'll ever need, then jlog might just be your cup of tea. With jlog, we keep things simple and to the point, because who has time for complexity?
|
||||
Features
|
||||
|
||||
Logging: Yes, we log things. Sometimes.
|
||||
Output: Logs messages to both stdout and a specified log file because we believe in options.
|
||||
Levels: We've got two: "Info" for the mundane, and "Error" for when things go south.
|
||||
|
||||
Installation
|
||||
|
||||
To install jlog, simply copy the jlog.h header file to your project and include it wherever you want to do some bare minimum logging. It's so simple, you'll wonder why you're reading installation instructions in the first place.
|
||||
Usage
|
||||
|
||||
Using jlog is straightforward:
|
||||
|
||||
cpp
|
||||
|
||||
#include "jlog.h"
|
||||
|
||||
int main() {
|
||||
jlog_info("This is barely useful information.");
|
||||
jlog_error("Oops, something went wrong.");
|
||||
|
||||
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™.
|
||||
|
||||
License
|
||||
|
||||
jlog is licensed under the "Do whatever you want with it, just don't blame us if it breaks something" license. Enjoy responsibly!
|
||||
Contributing
|
||||
|
||||
While we're not actively seeking contributions, if you have a burning desire to improve jlog, feel free to submit a pull request. Just keep it simple, okay?
|
||||
Disclaimer
|
||||
|
||||
Warning: Using jlog may result in a strange mixture of satisfaction for its simplicity and frustration for its lack of features. Side effects may include contemplating whether to switch to a more fully-featured logging solution. Use at your own risk.
|
||||
Send'em pull requests.
|
||||
Reference in New Issue
Block a user