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 ###Changelog
  23
  24 - 0.2 (2016-01-25)
  25   - History file operations added
  26   - EOF is now properly handled
  27 - 0.1 (2016-01-25)
  28   - Readline is working
  29   - History works but no control over it
  30
  31 ###Todo
  32
  33 - Embed the readline library in the object files in such a way that no special
  34   compiler flag is needed.
  35 - Control over history, right now entries are added automatically to the
  36   history when the boolean flag is on. It would be nice to be able to add
  37   custom entries.
  38 - Control over tabcompletion, right now it completes on filenames.
  39 - Check possibilities for Windows/Mac
  40
  41 ###Author
  42
  43 Mart Lubbers (mart at martlubbers.net)