README.md

Consolex

Facilitator of reading and writing on the console.

---

❇ Introduction

Complete and easy-to-use console, featuring logging, read and write operations on the console, as well as text file display operations.

❓ How to use

1. Add the content of the src folder to the folder containing your project's source files

2. Add the content of the include folder to the folder containing your project's header files

3. Copy the Makefile to your project's root folder (if you already has one, merge the files)

4. Run the following commands:

$ make clean
$ make

5. Use it

[...]

#include "wniemiec/io/consolex/Consolex.hpp";

[...]

std::string line = "hello world";
Consolex::write_header(line);

Consolex::write_line("Simple console message");

Consolex::write_error("Error message");
Consolex::write_warning("Warning message");
Consolex::write_info("Info message");
Consolex::write_debug("Debug message");

[...]

Note: You can use cmake if you wish. To do this, use the CMakeLists.txt file.

📖 Documentation

Property	Parameter type	Return type	Description	Default parameter value
read_line	void	std::string	Reads a line from console	-
write_line	line: std::string	void	Write a line on the console, putting a line break at the end	-
write_lines	lines: std::list<std::string>	void	Write lines on the console, putting a line break at the end of each line	-
write	content: std::string	void	Writes a content on the console without putting a line break at the end of each line	-
write_file_lines	filepath: std::string	void	Write lines from a text file to the console	-
write_file_lines_with_enumeration	filepath: std::string	void	Write lines from a text file to the console. Besides, it shows the line number of each line on the left	-
write_div	symbol: std::string	void	Writes a division line	"-"
write_header	title: std::string, symbol: std::string	void	Writes a title between two dividers	- , "-"
write_error	message: std::string	void	Displays an error message.	-
write_warning	message: std::string	void	Displays a warning message.	-
write_info	message: std::string	void	Displays an info message. -
write_debug	message: std::string	void	Displays a debug message.	-
clear_history	void	void	Clears the history of messages sent to the console	-
dump_to	directory_path: std::string	void	Exports the history of messages sent to the console to a file	-
get_history	void	std::vector<std::string>	Gets messages sent to the console	-
set_margin_left	margin: int	void	Defines the distance between messages and the log level tag	-
set_logger_level	level: LogLevel*	void	Sets log level. The level defines what type of message will be displayed	-

🚩 Changelog

Details about each version are documented in the releases section.

🤝 Contribute!

See the documentation on how you can contribute to the project here.

📁 Files

/

Name	Type	Description
dist	Directory	Released versions
docs	Directory	Documentation files
src	Directory	Source files