README

   1 CAVE (Character Animation Viewer for Everyone) is an ascii animation viewer.
   2 It uses (n)curses for it's interface so you'll need to have those libraries
   3 installed. It currently has the following features:
   4
   5     - frame stepping
   6     - scrolling for frames larger than screen
   7     - fps adjustment and frame cueing
   8     - supports multiple files and file reloading
   9     - looping
  10     - play in reverse
  11     - frame marking
  12     - screensaver with file shuffle and timeout adjustment
  13     - fullscreen toggle
  14     - change foreground and background colors
  15     - comprehensive status bar
  16     - builtin help
  17     - supports gzipped compressed files
  18     - extended regular expressions for frame deliminators
  19     - support for per-frame delays
  20     - autodetect position of frame deliminator
  21
  22 To install you should be able to type './configure && make && make install' to
  23 configure, build and install the binary and manual page. Then type 'cave' to
  24 see the available command-line options. If you have problems with the build,
  25 let me know what OS your running and the version of the (n)curses libraries
  26 you have installed. CAVE has been known to build on FreeBSD, MacOS X and
  27 Linux. It should be fairly portable though.
  28
  29 A list of things planned can be found in the TODO file. Also, bugs that are
  30 known about can be found in the BUGS file. Please let me know of any new bugs
  31 you find.
  32
  33 Ben Kibbey <bjk@luxsci.net>
  34 http://bjk.sourceforge.net/cave/