diff --git a/README.md b/README.md index c2a8006..de5326b 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,13 @@ If you do not like our function/method names, feel free to define names that sui etc. ### TerSer Installation +#### Install in Arduino Library Manager +* (not active yet!) * Go to library manager in your Arduino IDE and search for 'TerSer'. +Use the following syntax to include: +`#include ` +#### Install manually, portable with sketch Alternatively just download the TerSer.h into your sketch folder and include it directly from your sketch folder with: `#include "TerSer.h"` @@ -84,10 +89,10 @@ For more information please see the [ATmega328 Datasheet](http://ww1.microchip.c ### Function reference -| TerSer function | Description | Example Code | +| TerSer function | Description | Example use | | --------------- | --------------- | --------------- | | `Car(cc);` | Send code cc to the UART | `Car(' '); Car(32); Car(0x20); //All three print a space` | -| `cc=Get();` | Wait for a key depressed. Use Teraterm, or other terminal software that does not work line-oriented. | `Car( Get() ); //Echo of the typed character` | +| `cc=Get();` | Wait for a key depressed. Use Teraterm, or other terminal software that does not work line-oriented. | `Car( Get() ); //Echo typed character` | | `Text("abcd");` | Send the text and add a space | | | `Textln("abcd");` | Same with CRLF | | | `CR();` | Send a CR-LF | | @@ -105,4 +110,4 @@ For more information please see the [ATmega328 Datasheet](http://ww1.microchip.c | `Zeros();` | +00nnn if you prefer | | | `Compact();` | +nnn same as Arduino, but a + is shown if positive signed variable | | - +See the included example code for practical usage of the TerSer library. diff --git a/docs/TerSer.doc b/docs/TerSer.doc index 8110571..fdf9797 100644 Binary files a/docs/TerSer.doc and b/docs/TerSer.doc differ