From a5a729054a05a7e5a9a93b6ea54d9795f3c232b9 Mon Sep 17 00:00:00 2001 From: Chris Punches Date: Mon, 28 Dec 2020 22:20:25 -0500 Subject: [PATCH] updated readme for reviewers --- README.md | 10 ++++++++++ src/Logger/Logger.cpp | 4 ++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0e20b45..5c757f1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ +# Examplar + +## What is Examplar? + +Examplar is an execution flow component designed for the generation of SURRO Linux but kept broad in design for other use cases. + +At a high level, it is a very simple thing: It executes scripts and other executables in a predetermined order, logs their output, and has basic error handling using exit codes of the executables it is running. + +It relies on a library of Units which are files that define, in json format, what executables it can execute. It uses a Plan to define which of those units it will actually execute. This allows you to have many things defined by multiple teams, and, with sufficient abstraction, use the same library of automations for multiple purposes. + # Instructions These are instructions for using Examplar. diff --git a/src/Logger/Logger.cpp b/src/Logger/Logger.cpp index d1a2508..8589b06 100644 --- a/src/Logger/Logger.cpp +++ b/src/Logger/Logger.cpp @@ -33,9 +33,9 @@ void Logger::log( int LOG_LEVEL, std::string msg ) if ( LOG_LEVEL == E_FATAL | LOG_LEVEL == E_WARN ) { - std::cerr << "[" << this->get_8601() << "]\t[" << this->mask << "]\t[" << ERR << "]\t" << msg.c_str() << std::endl; + std::cerr << "[" << this->get_8601() << "] [" << ERR << "] " << "[" << this->mask << "] " << msg.c_str() << std::endl; } else { - std::cout << "[" << this->get_8601() << "]\t[" << this->mask << "]\t[" << ERR << "]\t" << msg.c_str() << std::endl; + std::cout << "[" << this->get_8601() << "] [" << ERR << "] " << "[" << this->mask << "] " << msg.c_str() << std::endl; } } }