README.md

   1 concol - a library for colourful terminal apps
   2 ==============================================
   3
   4 most modern terminal emulators feature plenty of colors, between 64 - 256.
   5 the major hindrance to its usage is that the (n)curses library makes it very
   6 difficult to use them. it sees colors as colorpairs which have to be set up
   7 one after the other, resulting in a ton of code and work to do so.
   8
   9 concol offers a simple API that allows the programmer to just throw an RGB
  10 value at it (either for background or foreground color) and use that at once.
  11 the tedious colorpair manipulation is all done automatically by the library.
  12
  13 as a bonus, there are 3 different backends:
  14
  15 - (n)curses backend (works as well with netbsd curses)
  16 - SDL backend
  17 - termbox backend (8 colors only)
  18
  19 the SDL backend is perfect for developing the app as it allows to debug the
  20 application without interference between the terminal modes used by GDB and
  21 the app itself, which is usually a major pain when developing ncurses apps.
  22
  23 the termbox backend otoh is good to make tiny static linked programs when
  24 8 colors are sufficient, since it is much smaller than (n)curses.
  25 (note that termbox development diverged a lot from its original goals after
  26 commit 66c3f91b. thus it is advised to use the parent of this commit, or use
  27 the fork cursebox ( https://github.com/strake/cursebox.c ) (untested).
  28 later termbox version weren't tested as well, so they may not work due to
  29 changed API.
  30
  31 see the examples directory for usage of this library.
  32
  33 Compilation
  34 -----------
  35
  36     make BACKEND=SDL
  37
  38 or
  39
  40     make BACKEND=SDL2
  41
  42 or
  43
  44     make BACKEND=NCURSES
  45
  46 or
  47
  48     make BACKEND=TERMBOX
  49
  50 if you want to build the example programs, do the same, but use the examples
  51 target, e.g.
  52
  53     make BACKEND=NCURSES examples
  54
  55 TODO
  56 ----
  57 it might make sense to start using the colors internally from 256 downwards,
  58 as this has the advantage that the original 16 terminal colors never get changed
  59 when using less than 240 colors (ncurses backend).