README.md

   1 Clean readline Version 0.1
   2 ==========================
   3
   4 ReadLine is a Clean library that allows interactive console programs to use the
   5 GNU readline libraries. At the moment this is only tested on Linux.
   6
   7 ###Usage
   8 To setup the library you can simply run
   9 ```
  10 make -C Clean\ System\ Files
  11 ```
  12
  13 To compile and test the test program you can run
  14 ```
  15 make
  16 ./test
  17 ```
  18
  19 When you want to use the library in your program you should compile with the
  20 `-l /usr/lib/libreadline.so` linker flag
  21
  22 ###Todo
  23
  24 - Test how the library reacts on non terminal stdin and EOF
  25 - Embed the readline library in the object files in such a way that no special
  26   compiler flag is needed.
  27 - Control over history, right now entries are added automatically to the
  28   history when the boolean flag is on. It would be nice to be able to add
  29   custom entries.
  30 - Control over tabcompletion, right now it completes on filenames.
  31 - Check possibilities for Windows/Mac
  32
  33 ###Author
  34
  35 Mart Lubbers (mart at martlubbers.net)