zarox28 / logger-cpp

Simple logging library in C++

Logger

Version: 1.2.0

---

Table of Contents

• About
• Features
• Installation
• Usage
  • Init
  • Reset
  • Debug
  • Info
  • Success
  • Warning
  • Error
  • Fatal
• Changelog
• Contributing
• License
• Authors

About

This is a simple C++ logger that can be used to log messages to the console or to a file.

Features

• Debug, Info, Warning, Error and Fatal log levels

Installation

1. Add the Logger submodule to your project

git submodule add https://github.com/Zarox28/Logger.git libs/Logger

2. Initialize the submodule & update it

git submodule update --init --recursive

3. Include the Logger header file in your project

#include "libs/Logger/Logger.h"

Note: The Logger submodule is located in the libs directory of your project.

Tip: You can also add using namespace Logger; to your project to avoid having to type Logger:: before every log level.

Usage

Init

Logger::init();

Reset

Logger::reset();

Debug

Logger::debug("This is a debug message");

Preview

Info

Logger::info("This is an info message");

Preview

Success

Logger::success("This is a success message");

Preview

Warn

Logger::warn("This is a warning message");

Preview

Error

Logger::error("This is an error message");

Preview

Fatal

Logger::fatal("This is a fatal message");

Preview

Note: Fatal log message blink in red to catch the user's attention.

Changelog

see CHANGELOG.md for latest changes.

Contributing

Contributing is disabled for this repository.

License

This project is licensed under the AGPL v3 License - see the LICENSE file for details.

Authors

• @Zarox28