Adding SparkFun name to all examples, updating README, adding library…

….properties file

Examples/PrintBitmap/PrintBitmap.ino → Examples/SparkFunPrintBitmap/SparkFunPrintBitmap.ino

@@ -1,5 +1,5 @@
 /*
-  ChronoLCD Color - An example sketch for the Color LCD Shield Library
+  PrintBitmap - An example sketch for the Color LCD Shield Library
   by: Jim Lindblom
   SparkFun Electronics
   date: 6/23/11

README.md

@@ -1,19 +1,53 @@
-# ColorLCDShield
+SparkFun Color LCD Shield Arduino Library
+==========================================
 
-This is a simple Arduino library for use specifically with SparkFun Electronics' [Color LCD Shield](http://www.sparkfun.com/products/9363). It'll no doubt work with other incarnations of LCD breakouts and what not, you just might have to do some modifying of the pin defintions.
+![Color LCD Shield](https://dlnmh9ip6v2uc.cloudfront.net/images/products/9/3/6/3/09363-01b_i_ma.jpg) 
+
+[*Color LCD Shield (LCD-09363)*](https://www.sparkfun.com/products/9363)
 
-## License
-Creative Commons Share-alike 3.0 ([CC-BY SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/)). Use this code however you'd like, just keep this license and attribute. Let us know if you make hugely, awesome, great changes.
+This is a simple Arduino library for use specifically with SparkFun Electronics' [Color LCD Shield](http://www.sparkfun.com/products/9363). 
+It'll no doubt work with other incarnations of LCD breakouts and what not, you just might have to do some modifying of the pin defintions.
 
-## How to use the library
+Repository Contents
+-------------------
+
+* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. 
+* **/src** - Source files for the library (.cpp, .h).
+* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. 
+* **library.properties** - General library properties for the Arduino package manager. 
+
+Documentation
+--------------
+
+* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
+* **[Product Repository](https://github.com/sparkfun/ColorLCDShield)** - Main repository (including hardware files) for the SparkFun Color LCD Shield.
+* **[Hookup Guide](https://www.sparkfun.com/tutorials/286)** - Basic hookup guide for the SparkFun Color LCD Shield.
+
+
+License Information
+-------------------
+
+This product is _**open source**_! 
+
+The **code** is beerware; if you see me (or any other SparkFun employee) at the local, and you've found our code helpful, please buy us a round!
+
+Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release anything derivative under the same license.
+
+Distributed as-is; no warranty is given.
+
+- Your friends at SparkFun.
+
+
+How to use the library
+-----------------------
 The code gives you access to the following LCD functions:
 
-###LCDShield()
+**LCDShield()**
 The library's constructor. An instance of the lcd must be created at the beginning of any code. e.g:
 
 	LCDShield lcd;
 
-###void init(int type, bool colorSwap)
+**void init(int type, bool colorSwap)**
 This initializes an LCD. Either EPSON or PHILLIPS should be passed as the type variable. This function should be called near the beginning of any sketch (setup()!). Turns on the display, sets the contrast and initializes the LCD into 12-bit RGB color mode.
 
 An optional variable, *colorSwap*, is useful if your blues and reds are swapped. By default this boolean variable is 0, and you don't have to specify it. Try making it 1 if you need to fix colors though (through my experience, I've seen Philips controllers go both ways.
@@ -24,45 +58,45 @@ Examples:
 	lcd.init(EPSON);	// Initialize and LCD with an EPSON controller
 	lcd.init(PHILIPS, 1);	// Initialize with a PHILIPS controller, but swap all reds and blues.
 
-###void clear(int color)
+**void clear(int color)**
 Clears the entire screen, filling it with the 12-bit RGB color passed to it. There are a number of predefined colors in *ColorLCDShield.h*.
 
-###void contrast(char setting)
+**void contrast(char setting)**
 Manually adjusts the contrast. The setting variable is different for Philips or Epson LCDs.
 
 For Philips, a signed value between -64 and 63 should be passed. I've found about -51 to work best.
 
 For Epson, a value between 0 and 63 should be passed. 40 works pretty well for me.
 
-###void setPixel(int color, unsigned char x, unsigned char y)
+**void setPixel(int color, unsigned char x, unsigned char y)**
 Draws a single pixel at the specified x, y location. Color is a 12-bit RGB value.
 
-###void setArc(int x0, int y0, int radius, int segments[], int numSegments, int lineThickness, int color)
+**void setArc(int x0, int y0, int radius, int segments[], int numSegments, int lineThickness, int color)**
 Draws an Arc centered at x0, y0 with the specified radius with the array of quadrant segments (NNE,ENE,ESE,SSE,SSW,WSW,WNW,NNW), number of quadrant segments, with the specified line thickness in pixels, or FILL to fill quadrant and color 12 bit RGB value.
 
-###void setCircle (int x0, int y0, int radius, int color, int lineThickness)
+**void setCircle (int x0, int y0, int radius, int color, int lineThickness)**
 Draws a circle centered around x0, y0, of the specified radius and color. Radius is in pixels, color is a 12-bit RGB value. LineThickness in Pixels or FILL to fill in circle (defaults to 1 pixel if not specified).
 
-###void setChar(char c, int x, int y, int fColor, int bColor)
+**void setChar(char c, int x, int y, int fColor, int bColor)**
 Sets a single character down at the specified x/y coordinate. You can pick both the foregroundand background color, they're 12-bit RGB values. Only one font is available in this library. Definitely room for growth, though at an added cost of memory.
 
-###void setStr(char *pString, int x, int y, int fColor, int bColor)
+**void setStr(char *pString, int x, int y, int fColor, int bColor)**
 Sets a string of characters down, beginning at x/y coordinates. You can pick both the foreground and background color, they're 12-bit RGB values. Only one font is available in this library. Definitely room for growth, though at an added cost of memory.
 
-###void setLine(int x0, int y0, int x1, int y1, int color)
+**void setLine(int x0, int y0, int x1, int y1, int color)**
 Draws a line from x0,y0 to x1,y1. Color is a 12-bit RGB value.
 
-###void setRect(int x0, int y0, int x1, int y1, unsigned char fill, int color)
+**void setRect(int x0, int y0, int x1, int y1, unsigned char fill, int color)**
 Draws a rectangle with opposing corners at x0,y0 and x1,y1. A 1 for fill will fill the entire rectangle, a 0 will only draw the border. Color is a 12-bit RGB value.
 
-###void printLogo(void)
+**void printLogo(void)**
 Prints the SparkFun logo. Good example of how to print a bitmap, though!
 
-###void printBMP(char[2048])
+**void printBMP(char[2048])**
 Prints a bitmap in monochrome on the screen. The bitmap can't be larger than 2048 bytes, and must be encoded into C hexadecimal in horizontal order. See the printBitmap example for more information.
 
-###void on(void)
+**void on(void)**
 Turns the display on.
 
-###void off(void)
+**void off(void)**
 Turns the display off. You'll still see the backlight on!

library.properties

@@ -0,0 +1,9 @@
+name=SparkFun Color LCD Shield
+version=1.0.0
+author=SparkFun Electronics
+maintainer=SparkFun Electronics
+sentence=This is an Arduino library for SparkFun's Color LCD Shield
+paragraph=This is an Arduino library for SparkFun's Color LCD Shield
+category=Other
+url=https://github.com/sparkfun/SparkFun_Color_LCD_Shield_Arduino_Library
+architectures=*