diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb8ca5a --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# libscterm — Terminal utilities and I/O-manipulators for ANSI escapes + +C++ library with terminal utilities and I/O-manipulators for ANSI escapes. Full +support for NO_COLOR environment variable. + +## Build + +`make` + +after installing dependency: + +- [libscerror](https://git.bobpolis.com/bob/libscerror/) + +## Install + +`sudo make install` + +or, on OpenBSD: + +`doas gmake install` + +## Documentation + +In progress. For now, please consult the library header at +`/usr/local/include/libscerror.hpp`, after successful installation.