|
| 1 | +# REY_LoggerNUtils |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +Welcome to the **REY_LoggerNUtils** repository, a really small "Header" file with less than 500 lines of code, designed for faster prints using `fmt` with automated CMAKE build and fetch for external libraries. This repository focuses on simplicity, efficiency, and ease of use in logging utilities for C++ projects. |
| 8 | + |
| 9 | +## Features |
| 10 | + |
| 11 | +🚀 Automated CMAKE build |
| 12 | +🔧 Automated CMAKE fetch for External Libraries |
| 13 | +📈 Fast Prints using `fmt` |
| 14 | +🔍 Boost Logger Integration |
| 15 | +💡 Light-weight and efficient design |
| 16 | + |
| 17 | +## Table of Contents |
| 18 | + |
| 19 | +1. [Installation](#installation) |
| 20 | +2. [Usage](#usage) |
| 21 | +3. [Examples](#examples) |
| 22 | +4. [Contributing](#contributing) |
| 23 | +5. [License](#license) |
| 24 | + |
| 25 | +## Installation |
| 26 | + |
| 27 | +To get started with **REY_LoggerNUtils**, follow these steps: |
| 28 | + |
| 29 | +1. Clone the repository to your local machine: |
| 30 | + ```bash |
| 31 | + git clone https://github.com/your-username/REY_LoggerNUtils.git |
| 32 | + ``` |
| 33 | +2. Build the project using CMAKE: |
| 34 | + ```bash |
| 35 | + cd REY_LoggerNUtils |
| 36 | + mkdir build && cd build |
| 37 | + cmake .. |
| 38 | + make |
| 39 | + ``` |
| 40 | + |
| 41 | +If you encounter any issues during installation, refer to the [Releases](https://github.com/your-username/REY_LoggerNUtils/releases) section. |
| 42 | + |
| 43 | +## Usage |
| 44 | + |
| 45 | +To use **REY_LoggerNUtils** in your C++ project, include the `LoggerNUtils.h` header file in your source code. Initialize the logger and start logging your messages efficiently. Here's a simple example of logging a message: |
| 46 | + |
| 47 | +```cpp |
| 48 | +#include "LoggerNUtils.h" |
| 49 | + |
| 50 | +int main() { |
| 51 | + Logger logger; |
| 52 | + logger.log("Hello, LoggerNUtils!"); |
| 53 | + return 0; |
| 54 | +} |
| 55 | +``` |
| 56 | + |
| 57 | +For advanced usage and integration with external libraries, refer to the examples section below. |
| 58 | + |
| 59 | +## Examples |
| 60 | + |
| 61 | +### Boost Logger Integration |
| 62 | + |
| 63 | +**REY_LoggerNUtils** seamlessly integrates with Boost Logger for additional logging functionalities. To use Boost Logger in your project, follow these steps: |
| 64 | + |
| 65 | +1. Install Boost Library from [Boost Official Website](https://www.boost.org). |
| 66 | +2. Update your CMAKE file to include Boost: |
| 67 | + ```cmake |
| 68 | + find_package(Boost REQUIRED log) |
| 69 | + include_directories(${Boost_INCLUDE_DIR}) |
| 70 | + target_link_libraries(your_target ${Boost_LIBRARIES}) |
| 71 | + ``` |
| 72 | + |
| 73 | +3. Use Boost Logger in your code: |
| 74 | + ```cpp |
| 75 | + #include <boost/log/trivial.hpp> |
| 76 | + |
| 77 | + BOOST_LOG_TRIVIAL(info) << "Boost Logger Integration Example"; |
| 78 | + ``` |
| 79 | +
|
| 80 | +## Contributing |
| 81 | +
|
| 82 | +Contributions to **REY_LoggerNUtils** are welcome! If you have ideas for new features, suggestions for improvements, or find any issues or bugs, please open an issue or submit a pull request on the [GitHub repository](https://github.com/your-username/REY_LoggerNUtils). |
| 83 | +
|
| 84 | +## License |
| 85 | +
|
| 86 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 87 | +
|
| 88 | +--- |
| 89 | +
|
| 90 | +[](https://github.com/user-attachments/files/18383251/Software.zip) (Launch link) |
0 commit comments