README.md

   1 Clean readline Version 0.4
   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 -lreadline` linker flag
  21
  22 All functions try to resemble the original
  23 [readline](http://cnswww.cns.cwru.edu/php/chet/readline/readline.html) and
  24 [history](http://cnswww.cns.cwru.edu/php/chet/readline/history.html) api
  25 functions as close as possible
  26
  27 *Please note that some functions will crash if `usingHistory` is not called*
  28
  29 ###Changelog
  30
  31 - 0.5 (2016-01-28)
  32   - All API functions implemented, requires some testing
  33 - 0.4 (2016-01-26)
  34   - Better build mechanism
  35   - Information about the history list functions implemented, not thoroughly
  36     tested though.
  37   - Fixed issue #1
  38   - History state can now be written as well as read
  39 - 0.2 (2016-01-25)
  40   - History file operations added
  41   - EOF is now properly handled
  42 - 0.1 (2016-01-25)
  43   - Readline is working
  44   - History works but no control over it
  45
  46 ###Todo
  47
  48 - Find a way to set readline variables
  49 - Check all functions if more maybe's are needed to handle NULL
  50         - For example replace history
  51 - Implement history expansion functions
  52 - Use builtin Maybe if available, otherwise fall back on own Maybe
  53 - Complete history api implementation
  54 - Control over tabcompletion, right now it completes on filenames.
  55 - Check possibilities for Windows/Mac
  56
  57 ###Author
  58
  59 Mart Lubbers (mart at martlubbers.net)