diff --git a/Makefile b/Makefile index 8e02579..89ac202 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ include config.mk -install: src/libcolor.h - install src/libcolor.h $(PREFIX)/include/libcolor.h +install: src/color.h + install src/color.h $(PREFIX)/include/color.h diff --git a/README b/README index 236ce70..138bb38 100644 --- a/README +++ b/README @@ -1,16 +1,18 @@ + libcolor -A library to style programs with command-line interaction. Includes colors and symbols. +A library to style programs with command-line interaction. + Usage + #include #include - #include "libcolor.h" - int main() { + int + main() + { printf(COL_RED "red\n" COL_RESET); printf(COL_BLUE "blue\n" COL_RESET); - printf(TXT_BOLd "bold\n" TXT_RESET); + printf(COL_GREEB "green\n" COL_RESET); } + Installation diff --git a/man/libcolor.3 b/man/libcolor.3 new file mode 100644 index 0000000..eb7e7fa --- /dev/null +++ b/man/libcolor.3 @@ -0,0 +1,16 @@ +.\" Manpage for libcolor. +.TH man 3 "11 May 2023" "1.0" "Everest Linux Libraries Manual" +.SH NAME +libcolor \- color output support for C programs +.SH SYNOPSIS + #include + + printf(COL_RED COL_RESET); +.SH DESCRIPTION +libcolor is a header file that aims to support printing colors in C programs in a more readable way. +.SH SEE ALSO +libecrypt(3) +.SH BUGS +Report all bugs on the issues page at https://git.everestlinux.org/EverestLinux/libcolor +.SH AUTHOR +Liam Waldron (liamwaldron@everestlinux.org) diff --git a/src/libcolor.h b/src/color.h similarity index 100% rename from src/libcolor.h rename to src/color.h