From: asterix <asterix@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Wed, 28 Sep 2011 15:11:19 +0000 (+0000)
Subject: Write the doc for sam3 examples.
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=710780c30a26bdbdebe3e92b6fde1af0b04a91a3;p=bertos.git

Write the doc for sam3 examples.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@5116 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/boards/sam3x-ek/examples/sam3x-ek_codec/.spec b/boards/sam3x-ek/examples/sam3x-ek_codec/.spec
index d6f56060..a8c587d1 100644
--- a/boards/sam3x-ek/examples/sam3x-ek_codec/.spec
+++ b/boards/sam3x-ek/examples/sam3x-ek_codec/.spec
@@ -1 +1,13 @@
-name = 'sam3x-ek_codec preset'
\ No newline at end of file
+name = 'Simple WAV player and recorder.'
+description="""
+<h2>Overview</h2>
+<p>
+This example application demonstrates how to make simple wav player, using WM8731 audio codec.
+<\p>
+<p>
+With the application we could explore the file on the SD card and start streaming pressing
+<b>Right button</b>, and to stop it by re-pressing the same button. While to record one stream
+follow the instruction on display, and then we can play it using the player menu.
+All wav file should be encoded in 16bit PCM, 2 Channel, 44100Hz.
+<\p>
+"""
diff --git a/boards/sam3x-ek/examples/sam3x-ek_http_server/.spec b/boards/sam3x-ek/examples/sam3x-ek_http_server/.spec
index 2f994508..107c2d22 100644
--- a/boards/sam3x-ek/examples/sam3x-ek_http_server/.spec
+++ b/boards/sam3x-ek/examples/sam3x-ek_http_server/.spec
@@ -1 +1,22 @@
-name = 'sam3x-ek_http_server preset'
\ No newline at end of file
+name = 'Simple HTTP server'
+description="""
+<h2>Overview</h2>
+<p>
+This example application demonstrates the usage of the lwIP TCP/IP stack with
+BeRTOS.
+<\p>
+<p>
+The DHCP protocol is used to obtain an IP address from an external DHCP server
+connected via ethernet.
+<\p>
+<p>
+The server reply to the client request sending the page that match the file stored on SD
+Card. If the SD or file is not preset, the server reply with header 404 FILE NOT found,
+and send harcoded html page that report the occured error.
+</p>
+<p>
+The BeRTOS simple HTTP server can reply the internal status or other things that the user wants, like: temperature,
+local ip, etc, to do this the client can load special pages that match an harcoded callbacks, where it return to client
+sending JSON string.
+</p>
+"""
diff --git a/boards/sam3x-ek/examples/sam3x-ek_sd_bootloader/.spec b/boards/sam3x-ek/examples/sam3x-ek_sd_bootloader/.spec
index 1a957719..28fb9c1c 100644
--- a/boards/sam3x-ek/examples/sam3x-ek_sd_bootloader/.spec
+++ b/boards/sam3x-ek/examples/sam3x-ek_sd_bootloader/.spec
@@ -1 +1,12 @@
-name = 'sam3x-ek_sd_bootloader preset'
\ No newline at end of file
+name = 'SD bootloader'
+description="""
+<h2>Overview</h2>
+<p>
+This example application demonstrates how to make simple bootloader with BeRTOS.
+<\p>
+<p>
+The bootloader start every time we reset the board, and check if SD card if present.
+If the SD is present the bootloader find on file system (FAT) the file named <b>firmware.bin</b>,
+and make simple check if the board need to be flashed. After that the bootloader jump to flashed application.
+</p>
+"""