Permalink
Browse files

add README and license

  • Loading branch information...
1 parent 253ba56 commit 47fcf009d8c7a629a6970c5b3e60ee065f74e24d @nottwo committed Nov 10, 2011
Showing with 891 additions and 0 deletions.
  1. +52 −0 README.md
  2. +674 −0 gpl.txt
  3. +165 −0 lgpl.txt
View
@@ -0,0 +1,52 @@
+BasicTerm
+=========
+
+BasicTerm is an Arduino library providing basic ANSI/VT220 terminal
+control over (typically) a serial connection.
+
+The canonical version of BasicTerm is available on
+[GitHub](http://github.com/nottwo/BasicTerm).
+
+Features
+--------
+
+* terminal initialization
+* clearing the screen
+* arbitrary positioning of the cursor
+* outputting characters and strings
+* showing and hiding the cursor
+
+Dependencies
+------------
+
+BasicTerm uses the F macro introduced in Arduino 1.0 to store constant
+strings in program flash memory and so will not work with prior versions
+of Arduino.
+
+It should be possible to use BasicTerm with Arduino 022 in combination
+with Mikal Hart's [Flash library](http://arduiniana.org/libraries/flash)
+with the accompanying modifications to the Print class.
+
+Installation
+------------
+
+Cloning the BasicTerm repository or copying the BasicTerm directory into
+~/sketchbook/libraries and restarting the Arduino IDE should be
+sufficient to make BasicTerm available in the Sketch | Import Library
+menu.
+
+License
+-------
+
+BasicTerm is licensed under the terms of the GNU Lesser
+General Public License v3.
+
+Author
+------
+Trannie Carter <borys@nottwo.org>
+
+Future development
+------------------
+
+* attributes
+* control sequence (function, arrow keys) reading
Oops, something went wrong.

0 comments on commit 47fcf00

Please sign in to comment.