Add README.md

This commit is contained in:
Bob Polis 2024-11-26 15:48:23 +01:00
parent f14a778aa9
commit 22840afe48

25
README.md Normal file
View File

@ -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.