]> pd.if.org Git - pd_readline/blobdiff - README
Cleanup of code. This version is much simpler and (sort of) works.
[pd_readline] / README
diff --git a/README b/README
index b3a0eca4174a23f22af99ca1d06711d9413a23cb..d2bed5e74f11a700033e8a9eb94a659b1d1584c2 100644 (file)
--- a/README
+++ b/README
@@ -1,23 +1,42 @@
 
  ***** README - pd_readline ***** 
 
 This repo is for the (eventual) storage of a public-domain  
-readline-and-command-history implementation. 
This repo is for the storage of a public-domain  
+readline-and-command-history implementation.  
 
-Update - 24th Aug 2012 - 
-Added the mg editor files from OpenBSD. 
-I obtained the code from here - 
-ftp://ftp.cc.uoc.gr/mirrors/OpenBSD/src/usr.bin/mg/
+FILES:  
 
-( It's not so much the editor itself that is the main interest here, 
-but the line-management code. )  
+pd_readline.c  -  This is a file to test the 
+implementation. Contains the main() function. 
 
-NOTE - in the mg directory, the file "theo.c" is NOT 
-"public domain" ( but it HAD to be included because of th
-humour......  ;)    )  
+test.txt -  A small text file to test scrolling 
+up and down with. This would be the "history" fil
+in a real readline implementation.  
 
-Many thanks to the OpenBSD team and the mg devs 
-(hi Theo - arrrrrrgh, please don't hit me........... ;)     )   
+
+Status - 31st Dec 2015 - "sort of works".  
+
+I'm back into doing work on this code. 
+
+I've reverted the code to a much simpler early version. 
+This compiles without errors and allows scrolling up 
+and down through the "test.txt" "dummy history" file. 
+It also allows editing of the command line. 
+However, edits are *not* yet saved in a history file.   
+
+Pressing Enter exits the program rather than storing 
+the existing command-line and "staying in the program". 
+I hope to change this soon.     
+
+You can edit a command-line (using backspace). 
+You can move around with left and right-arrow 
+keys. 
+"Dummy" history (from text.txt) can be recalled from a file with 
+the up-arrow key, and you can scroll up and down 
+through that file using the up and down arrows. 
+
+This code is released to the public domain.  
+"Share and enjoy........ ;)  "  
 
  - mooseman