Skip to content
This repository has been archived by the owner on Mar 28, 2024. It is now read-only.

Latest commit

 

History

History
48 lines (38 loc) · 2.15 KB

ReadMe.md

File metadata and controls

48 lines (38 loc) · 2.15 KB

Boxchar

Boxchar is a simple header only library for creating text based user interfaces in C and C++. It is designed to be lightweight and easy to use. At this stage, boxchar doesnt implement anywhere near as many features as ncurses.

Currently untested on windows so feedback would be appriciated

Features

  • Header-only: Easy to integrate with your project.
  • Cross-platform: Compatible with Windows and Unix-like operating systems.
  • Color support: Allows customization of text and background colors.
  • Lightweight and fast: Built with performance in mind.
  • UTF-8 and wide character support: For internationalization and localization.

Prerequisites

  • A C or C++ compiler.
  • Basic knowledge of C or C++ programming.

Installation

Since Boxchar is a header-only library, installation is as simple as copying boxchar.h into your project's include path. You can do this by adding it to your project manually or including it as a submodule in your git project.

Example

To compile the example run gcc boxchar.h example.c -o example in the terminal, and then run ./example to launch the example

Licence

MIT License

Copyright (c) 2023 Dane Madsen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.