mirror of
https://github.com/lwip-tcpip/lwip.git
synced 2024-11-04 14:29:39 +00:00
Integrate README file into doxygen docs instead of duplicating its content in main_page.h
This commit is contained in:
Dirk Ziegelmeier
parent
aece68639a
commit
0cb1d1144d
41
README
41
README
@ -10,28 +10,38 @@ while still having a full scale TCP. This making lwIP suitable for use
|
||||
in embedded systems with tens of kilobytes of free RAM and room for
|
||||
around 40 kilobytes of code ROM.
|
||||
|
||||
|
||||
FEATURES
|
||||
|
||||
* IP (Internet Protocol) including packet forwarding over multiple network
|
||||
interfaces
|
||||
* IP (Internet Protocol, IPv4 and IPv6) 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
|
||||
* MLD (Multicast listener discovery for IPv6). Aims to be compliant with
|
||||
RFC 2710. No support for MLDv2
|
||||
* ND (Neighbor discovery and stateless address autoconfiguration for IPv6).
|
||||
Aims to be compliant with RFC 4861 (Neighbor discovery) and RFC 4862
|
||||
(Address autoconfiguration)
|
||||
* 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
|
||||
* 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
|
||||
|
||||
|
||||
APPLICATIONS
|
||||
|
||||
* HTTP server with SSI and CGI
|
||||
* SNMPv2c agent with MIB compiler (Simple Network Management Protocol)
|
||||
* SNTP (Simple network time protocol)
|
||||
|
||||
|
||||
LICENSE
|
||||
|
||||
lwIP is freely available under a BSD license.
|
||||
|
||||
|
||||
DEVELOPMENT
|
||||
|
||||
lwIP has grown into an excellent TCP/IP stack for embedded devices,
|
||||
@ -57,15 +67,14 @@ The current Git trees are web-browsable:
|
||||
Submit patches and bugs via the lwIP project page:
|
||||
http://savannah.nongnu.org/projects/lwip/
|
||||
|
||||
Continuous integration builds (GCC, clang):
|
||||
https://travis-ci.org/yarrick/lwip-merged
|
||||
|
||||
|
||||
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/
|
||||
|
||||
Self documentation of the source code is regularly extracted from the
|
||||
current Git sources and is available from this web page:
|
||||
Self documentation of the source code is regularly extracted from the current
|
||||
Git sources and is available from this web page:
|
||||
http://www.nongnu.org/lwip/
|
||||
|
||||
There is now a constantly growin wiki about lwIP at
|
||||
@ -77,10 +86,12 @@ plus searchable archives:
|
||||
http://lists.nongnu.org/archive/html/lwip-users/
|
||||
http://lists.nongnu.org/archive/html/lwip-devel/
|
||||
|
||||
lwIP was originally written by Adam Dunkels:
|
||||
http://dunkels.com/adam/
|
||||
|
||||
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>
|
||||
|
||||
|
||||
@ -1,4 +1,8 @@
|
||||
/**
|
||||
* @defgroup lwip lwIP
|
||||
*
|
||||
* @defgroup infrastructure Infrastructure
|
||||
*
|
||||
* @defgroup callbackstyle_api Callback-style APIs
|
||||
* Non thread-safe APIs, callback style for maximum performance and minimum
|
||||
* memory footprint.
|
||||
@ -7,77 +11,21 @@
|
||||
* Thread-safe APIs, blocking functions. More overhead, but can be called
|
||||
* from any thread except TCPIP thread.
|
||||
*
|
||||
* @defgroup infrastructure Infrastructure
|
||||
*
|
||||
* @defgroup addons Addons
|
||||
*
|
||||
* @defgroup apps Applications
|
||||
*/
|
||||
|
||||
/**
|
||||
* @page contrib How to contribute to lwIP
|
||||
* @verbinclude "contrib.txt"
|
||||
/** @mainpage Overview
|
||||
* @verbinclude "README"
|
||||
*/
|
||||
|
||||
/**
|
||||
* @page upgrading Upgrading
|
||||
* @verbinclude "UPGRADING"
|
||||
*/
|
||||
|
||||
/*! \mainpage lwIP Documentation
|
||||
*
|
||||
* \section intro_sec 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 Science (SICS).
|
||||
*
|
||||
* The focus of the lwIP TCP/IP implementation is to reduce resource usage while still having a full scale TCP. This making lwIP suitable for use in embedded systems with tens of kilobytes of free RAM and room for around 40 kilobytes of code ROM.
|
||||
*
|
||||
* \section lwip_features_sec lwIP features:
|
||||
*
|
||||
* \li \c IP (Internet Protocol, IPv4 and IPv6) including packet forwarding over multiple network interfaces\n
|
||||
* \li \c ICMP (Internet Control Message Protocol, IPv4 and IPv6) for network maintenance and debugging\n
|
||||
* \li \c IGMP (Internet Group Management Protocol) for multicast traffic management\n
|
||||
* \li \c MLD (Multicast listener discovery for IPv6). Aims to be compliant with RFC 2710. No support for MLDv2\n
|
||||
* \li \c ND (Neighbor discovery and stateless address autoconfiguration for IPv6). Aims to be compliant with RFC 4861 (Neighbor discovery) and RFC 4862 (Address autoconfiguration)\n
|
||||
* \li \c UDP (User Datagram Protocol) including experimental UDP-lite extensions\n
|
||||
* \li \c TCP (Transmission Control Protocol) with congestion control, RTT estimation and fast recovery/fast retransmit\n
|
||||
* \li \c raw/native API for enhanced performance\n
|
||||
* \li \c Optional Berkeley-like socket API\n
|
||||
* \li \c DNS (Domain names resolver)\n
|
||||
* \li \c DHCP (Dynamic Host Configuration Protocol)\n
|
||||
* \li \c AUTOIP (for IPv4, conform with RFC 3927)\n
|
||||
* \li \c PPP (Point-to-Point Protocol)\n
|
||||
* \li \c ARP (Address Resolution Protocol) for Ethernet\n
|
||||
*
|
||||
* \section lwip_apps_sec lwIP applications:
|
||||
*
|
||||
* \li \c HTTP server with SSI and CGI\n
|
||||
* \li \c SNMPv2c agent with MIB compiler (Simple Network Management Protocol)\n
|
||||
* \li \c SNTP (Simple network time protocol)\n
|
||||
*
|
||||
* \section install_sec Documentation
|
||||
*
|
||||
* Development of lwIP is hosted on Savannah, a central point for software development, maintenance and distribution. Everyone can help improve lwIP by use of Savannah's interface, Git and the mailing list. A core team of developers will commit changes to the Git source tree.\n
|
||||
* http://savannah.nongnu.org/projects/lwip/\n
|
||||
* \n
|
||||
* Self documentation of the source code is regularly extracted from the current Git sources and is available from this web page:\n
|
||||
* http://www.nongnu.org/lwip/\n
|
||||
* \n
|
||||
* There is now a constantly growin wiki about lwIP at\n
|
||||
* http://lwip.wikia.com/\n
|
||||
* \n
|
||||
* Also, there are mailing lists you can subscribe at\n
|
||||
* http://savannah.nongnu.org/mail/?group=lwip\n
|
||||
* plus searchable archives:\n
|
||||
* http://lists.nongnu.org/archive/html/lwip-users/\n
|
||||
* http://lists.nongnu.org/archive/html/lwip-devel/\n
|
||||
* \n
|
||||
* Continuous integration builds (GCC, clang):\n
|
||||
* https://travis-ci.org/yarrick/lwip-merged\n
|
||||
* \n
|
||||
* lwIP was originally written by Adam Dunkels:\n
|
||||
* http://dunkels.com/adam/\n
|
||||
* \n
|
||||
* 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.\n
|
||||
*
|
||||
|
||||
/**
|
||||
* @page contrib How to contribute to lwIP
|
||||
* @verbinclude "contrib.txt"
|
||||
*/
|
||||
|
||||
@ -36,8 +36,6 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup lwip lwIP
|
||||
*
|
||||
* @defgroup lwip_nosys NO_SYS ("mainloop") mode
|
||||
* @ingroup lwip
|
||||
* Use this mode if you do not run an OS on your system. \#define NO_SYS to 1.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user