]> rtime.felk.cvut.cz Git - pes-rpp/rpp-lwip.git/blobdiff - README
Use FreeRTOS heap instead of LwIP heap
[pes-rpp/rpp-lwip.git] / README
diff --git a/README b/README
index ed0ee46d0f4fbec55fdf9a887821aca289f0ccf8..a62cc4f38c87952e05f86efeb9cc750f8b3ca8db 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,5 @@
+INTRODUCTION
+
 lwIP is a small independent implementation of the TCP/IP protocol
 suite that has been developed by Adam Dunkels at the Computer and
 Networks Architectures (CNA) lab at the Swedish Institute of Computer
@@ -5,52 +7,83 @@ Science (SICS).
 
 The focus of the lwIP TCP/IP implementation is to reduce the RAM usage
 while still having a full scale TCP. This making lwIP suitable for use
-in embedded systems with tenths of kilobytes of free RAM and room for
+in embedded systems with tens of kilobytes of free RAM and room for
 around 40 kilobytes of code ROM.
 
-lwIP features:
- * IP (Internet Protocol) including packet forwarding over multiple
-   network interfaces
- * ICMP (Internet Control Message Protocol) for network maintenance
-   and debugging
- * UDP (User Datagram Protocol) including experimental UDP-lite
-   extensions
- * TCP (Transmission Control Protocol) with congestion control, RTT
-   estimation and fast recovery/fast retransmit
- * Specialized API for enhanced performance
- * Optional Berkeley socket API
+FEATURES
+
+  * IP (Internet Protocol) including packet forwarding over multiple network
+    interfaces
+  * ICMP (Internet Control Message Protocol) for network maintenance and debugging
+  * IGMP (Internet Group Management Protocol) for multicast traffic management
+  * UDP (User Datagram Protocol) including experimental UDP-lite extensions
+  * TCP (Transmission Control Protocol) with congestion control, RTT estimation
+    and fast recovery/fast retransmit
+  * Specialized raw/native API for enhanced performance
+  * Optional Berkeley-like socket API
+  * DNS (Domain names resolver)
+  * SNMP (Simple Network Management Protocol)
+  * DHCP (Dynamic Host Configuration Protocol)
+  * AUTOIP (for IPv4, conform with RFC 3927)
+  * PPP (Point-to-Point Protocol)
+  * ARP (Address Resolution Protocol) for Ethernet
+
+LICENSE
 
 lwIP is freely available under a BSD license.
 
+DEVELOPMENT
+
 lwIP has grown into an excellent TCP/IP stack for embedded devices,
 and developers using the stack often submit bug fixes, improvements,
 and additions to the stack to further increase its usefulness.
 
 Development of lwIP is hosted on Savannah, a central point for
-software development, maintenance and distribution. A core team
-will improve lwIP by the use of Savannah's interface and CVS.
+software development, maintenance and distribution. Everyone can
+help improve lwIP by use of Savannah's interface, CVS and the
+mailing list. A core team of developers will commit changes to the
+CVS source tree.
+
+The lwIP TCP/IP stack is maintained in the 'lwip' CVS module and
+contributions (such as platform ports) are in the 'contrib' module.
 
-The current lwIP CVS tree can be checked out by doing:
-  cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip login
-  cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/lwip co lwip
+See doc/savannah.txt for details on CVS server access for users and
+developers.
 
 Last night's CVS tar ball can be downloaded from:
-  http://savannah.gnu.org/cvs.backups/lwip.tar.gz
+  http://savannah.gnu.org/cvs.backups/lwip.tar.gz [CHANGED - NEEDS FIXING]
+
+The current CVS trees are web-browsable:
+  http://savannah.nongnu.org/cgi-bin/viewcvs/lwip/lwip/
+  http://savannah.nongnu.org/cgi-bin/viewcvs/lwip/contrib/
 
 Submit patches and bugs via the lwIP project page:
   http://savannah.nongnu.org/projects/lwip/
 
-Stable releases have not been released yet. For development we
-suggest downloading the latest CVS and keeping track of the
-lwIP mailing list.
 
-The mailing list (and archives), as well as Adam Dunkels' papers
-on lwIP can be found on the official lwIP home page, which is
+DOCUMENTATION
+
+The original out-dated homepage of lwIP and Adam Dunkels' papers on
+lwIP are at the official lwIP home page:
   http://www.sics.se/~adam/lwip/
 
-Reading Adam Dunkels' papers and browsing the mailing list archives
-is a good way to become familiar with the design of lwIP.
+Self documentation of the source code is regularly extracted from the
+current CVS sources and is available from this web page:
+  http://www.nongnu.org/lwip/
+
+There is now a constantly growin wiki about lwIP at
+  http://lwip.wikia.com/wiki/LwIP_Wiki
+
+Also, there are mailing lists you can subscribe at
+  http://savannah.nongnu.org/mail/?group=lwip
+plus searchable archives:
+  http://lists.nongnu.org/archive/html/lwip-users/
+  http://lists.nongnu.org/archive/html/lwip-devel/
+
+Reading Adam's papers, the files in docs/, browsing the source code
+documentation and browsing the mailing list archives is a good way to
+become familiar with the design of lwIP.
 
 Adam Dunkels <adam@sics.se>
-Leon Woestenberg <leon.woestenberg@gmx.net>                
+Leon Woestenberg <leon.woestenberg@gmx.net>