From ed39b2da173b0d730b0a41dd5ecf7c4f5cba77ee Mon Sep 17 00:00:00 2001 From: LowPowerLab Date: Tue, 29 Jul 2014 17:21:36 -0400 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8ac7d1d..b515b2c 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@ SPIFlash ======== - -Arduino library for read/write access to SPI flash memory chips. -See code files for initial documentation, more to come soon. - +Arduino/Moteino library for read/write access to SPI flash memory chips. +This works with 256byte/page SPI flash memory such as the 4MBIT W25X40CLSNIG used on (Moteinos)[www.moteino.com] for data storage and wireless programming. +
+For instance a 4MBit (512Kbyte) flash chip will have 2048 pages: 256*2048 = 524288 bytes (512Kbytes) +Minimal modifications should allow chips that have different page size but modifications +DEPENDS ON: Arduino SPI library +
+This library was primarily developed to enable *safe* wireless programming on Moteino nodes and Moteino based applications such as the SwitchMote. This has been documented at (lowpowerlab)[http://lowpowerlab.com/blog/category/moteino/wireless-programming/]. + ###Installation Copy the content of this library in the "Arduino/libraries/SPIFlash" folder.
To find your Arduino folder go to File>Preferences in the Arduino IDE.
-See [this tutorial](http://learn.adafruit.com/arduino-tips-tricks-and-techniques/arduino-libraries) on Arduino libraries. \ No newline at end of file +See [this tutorial](http://learn.adafruit.com/arduino-tips-tricks-and-techniques/arduino-libraries) on Arduino libraries. + +###License +Copyright (c) 2013 by Felix Rusu +
+This library is free software; you can redistribute it and/or modify it under the terms of either the GNU General Public License version 2 or the GNU Lesser General Public License version 2.1, both as published by the Free Software Foundation.