Imported initial SHIMMER platform code.

[tinyos-2.x.git] / tos / platforms / shimmer / README.txt

diff --git a/tos/platforms/shimmer/README.txt b/tos/platforms/shimmer/README.txt
new file mode 100644 (file)
index 0000000..08ff4d7
--- /dev/null
+++ b/tos/platforms/shimmer/README.txt
@@ -0,0 +1,67 @@
+*** SHIMMER - TinyOS 2.x platform support ***\r
+=============================================\r
+Konrad Lorincz\r
+May 6, 2008\r
+\r
+This directory contains tinyos 2.x platform support for the Intel\r
+SHIMMER mote.  Please use the mailing list given below to post\r
+questions and comments.\r
+\r
+\r
+Usage\r
+-----\r
+You can compile and install applications for the SHIMMER platform just\r
+like with any standard platform, "make shimmer install ..." (Note:\r
+you must have a shimmer programming board).\r
+\r
+For example, to complie and install Blink, do the following:\r
+\r
+  $ cd $TOSROOT/apps/Blink\r
+  $ make shimmer install bsl,X\r
+\r
+where X is your serial port.\r
+\r
+You may also want to test the radio.  Do this by compiling and\r
+installing "$TOSROOT/apps/RadioCountToLeds" on TWO shimmers (for\r
+sending and receiving radio messages).\r
+\r
+\r
+Support\r
+-------\r
+  - Official documentation\r
+    http://docs.tinyos.net/index.php/SHIMMER\r
+  - Mailing list (requires subscription to post)\r
+    https://www.eecs.harvard.edu/mailman/listinfo/shimmer-users\r
+\r
+\r
+Copyright\r
+---------\r
+/*\r
+ * Copyright (c) 2008\r
+ *     The President and Fellows of Harvard College.\r
+ *\r
+ * Redistribution and use in source and binary forms, with or without\r
+ * modification, are permitted provided that the following conditions\r
+ * are met:\r
+ * 1. Redistributions of source code must retain the above copyright\r
+ *    notice, this list of conditions and the following disclaimer.\r
+ * 2. Redistributions in binary form must reproduce the above copyright\r
+ *    notice, this list of conditions and the following disclaimer in the\r
+ *    documentation and/or other materials provided with the distribution.\r
+ * 3. Neither the name of the University nor the names of its contributors\r
+ *    may be used to endorse or promote products derived from this software\r
+ *    without specific prior written permission.\r
+ *\r
+ * THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY AND CONTRIBUTORS ``AS IS'' AND\r
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE UNIVERSITY OR CONTRIBUTORS BE LIABLE\r
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
+ * SUCH DAMAGE.\r
+ */\r
+\r