Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.32 KB

README.md

File metadata and controls

37 lines (24 loc) · 1.32 KB
Raw

Ncursescpp

A RAII-conform C++ ncurses wrapper.

Ncurses features supported by ncursescpp :

  • Text output
  • Keyboard and mouse input
  • Colors and attributes
  • Windows
  • Subwindows

Ncursescpp is still WIP and more features will be added.

Philosophy

Ncursescpp goal is to provide access to ncurses through an interface using C++ resource management idiom, RAII. Each ncurses object (windows, colors, etc) is managed in an automatic and transparent way.

Installing

Ncursescpp is a header-only library. You can use CMake to install, or copy the library files where you want. Using ncursescpp in a program requires a compiler supporting the C++11 standard.

A CMake target is also created. Use Ncursescpp in your CMakeLists.txt like so:

find_package(ncursescpp REQUIRED)
target_link_libraries(${PROJECT_NAME}
  PUBLIC ncursescpp::ncursescpp
)

License

Ncursescpp is distributed under the CeCILL-B license (akin to the MIT license). See the LICENSE file or http://www.cecill.info/index.en.html for more information.

Documentation

You can generate the library documentation with Doxygen. Go to the doc/ directory and run doxygen Doxyfile. The documentation only contains information about ncursescpp interface, as ncurses is already fully documented.