Added TosThreads support for Mulle.

[tinyos-2.x.git] / apps / tosthreads / apps / TestBlockStorage / README

diff --git a/apps/tosthreads/apps/TestBlockStorage/README b/apps/tosthreads/apps/TestBlockStorage/README
index dac5ad39f7adf5d6fb0c5d4f5220409ecd602892..70d4c38f0e982afb440ec86854cbe0b65527e2f4 100644 (file)
--- a/apps/tosthreads/apps/TestBlockStorage/README
+++ b/apps/tosthreads/apps/TestBlockStorage/README
@@ -1,2 +1,28 @@
-This program erases volume, then randomly write (then verified by read).
-Led0 is ON during the test, and Led1 is ON if all tests pass. If there is a problem, all three LEDs will be ON.
+README for TOSThreads TestBlockStorage
+Author/Contact: tinyos-help@millennium.berkeley.edu
+Author: Kevin Klues <klueska@cs.stanford.edu>
+
+Description:
+
+This application is used to test the threaded version of the API for performing
+block storage.
+
+You can install TestBlockStorage on a mote via the following command:
+  make <platform> threads install
+
+Valid platforms are currently: tmote, telosb, mica2, micaz, iris and mulle
+
+This application first checks the size of the block storage volume, and
+erases it. Then, it randomly writes records, followed by a verification
+with read.
+
+Successful running of this application results in LED0 being ON
+throughout the duration of the erase, write, and read sequence. Finally,
+if all tests pass, LED1 is turned ON. Otherwise, all three LEDs are
+turned ON to indicate problems.
+
+Tools:
+  None.
+
+Known bugs/limitations:
+  None.