From 53704f7b368f18753f82f7004ddc90f8da40903b Mon Sep 17 00:00:00 2001
From: trsaunders <trsaunders@gmail.com>
Date: Mon, 13 Aug 2012 21:42:24 +0100
Subject: [PATCH] add basic console docs elaborate on contributions

---
 docs/console.txt      | 20 ++++++++++++++++++++
 docs/contributors.txt |  4 +++-
 2 files changed, 23 insertions(+), 1 deletion(-)
 create mode 100644 docs/console.txt

diff --git a/docs/console.txt b/docs/console.txt
new file mode 100644
index 00000000..09e7ae86
--- /dev/null
+++ b/docs/console.txt
@@ -0,0 +1,20 @@
+The console module acts as a BaseSequentialStream at a user defined area of the LCD.
+
+Requirements:
+The console code requires a lld that has vertical scroll implemented.
+It is also necessary to enable the scroll code:
+
+	#define GDISP_NEED_SCROLL TRUE
+
+Usage:
+
+	#include "console.h"
+	
+	/* Define a console object */
+	GLCDConsole CON1;
+	
+	/* initialise the console to take up the entire screen */
+	lcdConsoleInit(&CON1, 0, 0, 320, 240, &fontLarger, Black, White);
+	
+	/* print something */
+	chprintf((BaseSequentialStream *)&CON1, "Hello the time is %d\nGoodbye.", chTimeNow());
diff --git a/docs/contributors.txt b/docs/contributors.txt
index 289aa98f..70c7e660 100644
--- a/docs/contributors.txt
+++ b/docs/contributors.txt
@@ -10,6 +10,8 @@ Date			NickName		RealName				Contribution
 30.07.2012		inmarket		Andrew Hannam			halext implementation
 -				dxli			Dongxu Li				lcdDrawEllipse() filled option
 -				benwilliam		-						fastMath & lcdDrawEllipse()
--				Badger			Thomas Saunders			console implementation, FSMC
+-				Badger			Thomas Saunders			console implementation
+														FSMC for STM32F1 and F4
+														lld orientation fixes for S6D1121 and SSD1189
 -				Abhishek		Abhishek Kakkar			font rendering, S6D1121 GPIO