Add FatFS library to the Webserver project, extend the HTTP server so that it now...

[pub/USBasp.git] / Projects / Webserver / Webserver.txt

diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt
index e1d2985..e78cf5e 100644 (file)
--- a/Projects/Webserver/Webserver.txt
+++ b/Projects/Webserver/Webserver.txt
@@ -41,16 +41,22 @@
  *\r
  *  \section SSec_Description Project Description: \r
  *\r
  *\r
  *  \section SSec_Description Project Description: \r
  *\r

- *  Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack, to create a\r
- *  RNDIS host capable of serving out HTTP webpages to up to 10 hosts simultaneously. This project demonstrates how the two\r
- *  libraries can be combined into a robust network enabled application, with the addition of a RNDIS network device.\r
+ *  Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS\r
+ *  library to create a RNDIS host capable of serving out HTTP webpages to multiple hosts simultaneously. This project\r
+ *  demonstrates how the libraries can be combined into a robust network enabled application, with the addition of a RNDIS\r
+ *  network device.\r

  *\r
  *\r

- *  To use this project, plug the USB AVR into a RNDIS class device, such as a USB (desktop) modem. If compatible, the project\r
- *  will enumerate the device, set the appropriate parameters needed for connectivity and begin listening for new HTTP connections\r
- *  on port 80. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS device being used\r
- *  for this project to work.\r
+ *  To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load\r
+ *  HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called\r
+ *  <i>index.htm<i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver.\r
+ \r
+ *  When attached to a RNDIS class device, such as a USB (desktop) modem. If compatible, the system will enumerate the\r
+ *  device, set the appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80.\r
+ *  The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS device being used for this\r
+ *  project to work, if the DHCP client is disabled (see \ref SSec_Options).\r

  *\r
  *\r

- *  When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's IP address.\r
+ *  When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's static or\r
+ *  dynamically allocated IP address.\r

  *\r
  *  \section SSec_Options Project Options\r
  *\r
  *\r
  *  \section SSec_Options Project Options\r
  *\r


@@ -69,17 +75,17 @@
  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_IP_ADDRESS</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_IP_ADDRESS</td>\r

- *    <td>Webserver.h</td>\r
+ *    <td>Lib/uIPManagement.h</td>\r

  *    <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_NETMASK</td>\r
  *    <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_NETMASK</td>\r

- *    <td>Webserver.h</td>\r
+ *    <td>Lib/uIPManagement.h</td>\r

  *    <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_GATEWAY</td>\r
  *    <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>DEVICE_GATEWAY</td>\r

- *    <td>Webserver.h</td>\r
+ *    <td>Lib/uIPManagement.h</td>\r

  *    <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP\r
  *        is not defined).</td>\r
  *   </tr>\r
  *    <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP\r
  *        is not defined).</td>\r
  *   </tr>\r