ColorConsole библиотека позволяющая выводить цветной текст в консоль.

Библиотека используется в статьях блога - https://blog.altuninvv.ru

Содержание :

• 1. Описание библиотеки
  • 1.1. Возможности
  • 1.2. Поддерживаемые платформы
    • 1.2.1. Статус поддержки
• 2. Требования
  • 2.1. Стандарты C++
  • 2.2. Зависимости
• 3. Как собрать библиотеку
  • 3.1. Использование CMake
  • 3.1.1. Встраиваемая библиотека
  • 3.1.1. Статическая и разделяемая библиотеки
  • 3.2. Опции CMake
• 4. Как использовать библиотеку
  • 4.1. Использование
  • 4.2. Версии библиотеки
    • 4.2.1. Совместимость
• 5. Документация
• 6. Лицензия

1. Описание библиотеки

1.1. Возможности

• Вывод цветного текста в консоль Windows
• Изменение фона текста

• Сброс фона до настроек по умолчанию

  1.2. Поддерживаемые платформы

  1.2.1. Статус поддержки

• Windows - поддерживается Windows 10

• Linux - в настоящий момент не поддерживается

  2. Требования

  2.1. Стандарты C++

  Библиотека поддерживает стандарт C++ 17 и выше

  2.2. Зависимости

  У проекта нет внешних зависимостей. Библиотека собирается с использованием MSYS2 и компилятора GCC.

  3. Как собрать библиотеку

  3.1. Использование CMake

  3.1.1. Встраиваемая библиотека

  Данная библиотека может использоваться в качестве встраиваемой как папка в папке проекта : В главный файл CMakeLists.txtl добавьте :

# Если вы разместили библиотеку в папке lib: add_subdirectory(lib/colorconsole)
add_subdirectory(colorconsole) 

3.1.1. Статическая и разделяемая библиотеки

Данная библиотека может собираться с внешним проектом в качестве статической или разделяемой: В главный файл CMakeLists.txtl добавьте :

# ON - для сборки разделяемой, OFF - для сборки статической
option(BUILD_SHARED_LIBS "Build using shared libraries" OFF)

target_link_libraries(${PROJECT_NAME} PRIVATE ccon::colorconsole)

3.2. Опции CMake

Библиотека предоставляет следующие опции CMake:

• BUILD_SHARED_LIBS = ON | OFF

  • ON - собирать как разделяемую библиотеку

  • OFF - собирать как статическую библиотеку Использование:

    cmake -S . -B build -DBUILD_SHARED_LIBS=OFF
    

• BUILD_EXTERNAL_DOCS = ON | OFF

  • ON - собирать внешнюю документацию

  • OFF - собирать внутреннюю документацию Использование:

    cmake -S . -B build -DBUILD_EXTERNAL_DOCS=OFF
    

    4. Как использовать библиотеку

    4.1. Использование

    Примеры использования Пожалуйста обратитесь к документации класса ccon::ColorConsole.

    4.2. Версии библиотеки

    4.2.1. Совместимость

    Проблем с совместимостью не обнаружено.

5. Документация

Все классы и функции были задокументированы с помощью Doxygen.

Чтобы собрать документацию запустите:

cmake --build build --target docs

В папке ./build/docs/html/ будет создана документация.

6. Лицензия

Эта библиотека лицензирована под [лицензией GPLv3][repo-license-url].

[repo-license-url]: https://www.gnu.org/licenses/gpl-3.0.html