diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..73bd7f0c --- /dev/null +++ b/doc/README.md @@ -0,0 +1,43 @@ +Serval DNA Technical Documentation +---------------------------------- +[Serval Project][], May 2014 + +This directory contains [technical documents][] that accompany the [Serval +DNA][] component of the [Serval mesh network][]. + + * [Configuring Serval DNA](./Servald-Configuration.md) describes the + persistent configuration system and its command-line API, the built-in + system file paths, daemon instances and basic network configuration. + + * [Tunnelling](./Tunnelling.md) describes how to tunnel IP over the Serval + mesh network. + + * [Serval DNA on OpenWRT](./OpenWRT.md) describes how to build and install + Serval DNA packages for the OpenWRT platform. + + * [Serval DNA OpenBTS support](./OpenBTS.md) describes how Serval DNA has been + integrated with the Commotion Wireless OpenBTS mobile telephony platform. + + * [Mesh Datagram Protocol (MDP)](./Mesh-Datagram-Protocol.md) describes the + fundamental mesh protocol used in Serval Mesh networks and its C programming + API. + + * [Mesh Stream Protocol (MSP)](./Mesh-Stream-Protocol.md) describes a reliable + message stream protocol used in Serval Mesh networks and its C programming + API. + + * [Serval Infrastructure](./Serval-Infrastructure.md) contains notes on plans + for how a Serval mesh network can use the Internet to increase its reach and + usefulness. + +----- +**Copyright 2014 Serval Project Inc.** +![CC-BY-4.0](./cc-by-4.0.png) +This document is available under the [Creative Commons Attribution 4.0 International licence][CC BY 4.0]. + + +[Serval Project]: http://www.servalproject.org/ +[Serval DNA]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:servaldna: +[Serval mesh network]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:mesh_network +[technical documents]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:dev:techdoc +[CC BY 4.0]: http://creativecommons.org/licenses/by/4.0/