cstanze / roots

A "common tools" library for C++

Roots

Roots is a C++ library that provides a collection of common utilities and tools for other projects. It aims to simplify development by offering reusable components and functions.

Caveats

Roots is currently in development and may not be ready for production use. The API is subject to change at any time. Additionally, the library requires the C++20 standard which may not be supported by all compilers.

Features

• Environment detection and utilities (getting environment variables, cpu count, etc.)
• Filesystem utilities (path manipulation, file/directory creation, etc.)
• String utilities (string splitting, string trimming, etc.)
• Error handling/creation utilities (Result type, Error type)
• Useful C++ structures (BitFlags, TaggedUnion, etc.)
• C++20 Concepts (EqualityComparable, CopyConstructible, etc.)
• Process utilities (process spawning, process termination, etc.)
• Threading utilities (thread spawning, thread termination, etc.)
• Networking utilities (socket creation, socket termination, etc.)
• Logging utilities (logging to stdout, logging to file, etc.)

Installation

To include the Roots library in your C++ project, you can use CMake's FetchContent module. Follow the steps below:

Add the following lines to your CMakeLists.txt file:

include(FetchContent)

FetchContent_Declare(
  roots
  GIT_REPOSITORY https://github.com/cstanze/roots.git
  GIT_BRANCH main
)

FetchContent_MakeAvailable(roots)

Then, you can link against the Roots library in your CMakeLists.txt file:

target_link_libraries(<target> PRIVATE Roots::Roots)

Usage

To use the Roots library in your C++ project, you can include the header files in your source files:

#include <Roots/Environment.hpp>

or use the umbrella header:

#include <Roots/Roots.hpp>

License

Roots is licensed under the MIT license. See LICENSE for more information.