From 32aa787bf9fe7b6dd679e623a8f129e111c9bb8e Mon Sep 17 00:00:00 2001 From: javl Date: Mon, 25 Jan 2016 16:33:17 +0100 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7cb6820..c1b260f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ -Simple tool to create byte arrays from images to be used with small screens such as OLEDs. +## image2cpp ## -Use the converter at: http://javl.github.io/image2cpp/ +image2cpp is a simple tool to change images into byte arrays to use with (monochrome) displays suchs as OLEDs, like those from Adafruit or Sparkfun. While searching for a way to generate these arrays, I mostly found links to a piece of Windows software. Both the flakey results and the hassle of having to boot a virtual machine just to convert an image lead to me writing this pure html + javascript solution. + +Alternatively you can also enter a byte array as input to turn it back into an image. This might be useful for debugging, or when you want to write the byte array yourself. I don't know. + +### running the tool ### +You don't need any special dependencies / internet connection; all the necessary parts sit in a single .html file. So just open this index.html page in a (recent) browser to run the tool. +Or you can use the online version at: http://javl.github.io/image2cpp/ + +### Example Arduino code ### +You can find a simple Arduino example sketch [over here](https://github.com/javl/image2cpp/blob/master/oled_example/oled_example.ino) in the repository. + +### Screen types ### +I wrote the code with my 128x64 pixel monochrome OLED display in mind, but it should work with most similar displays. You might need to change some export settings; those are explained in the tool.