From 224da4467bb3f71575991251524bde6b890f968a Mon Sep 17 00:00:00 2001 From: Joseph Henry Date: Thu, 3 Nov 2016 15:55:48 -0700 Subject: [PATCH] updated docs --- README.md | 4 ++-- integrations/README.md | 11 ++++++++--- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5c726a9..fa03471 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -ZeroTier SDK (beta) +ZeroTier SDK ====== ZeroTier-enabled apps. Virtual network access embedded directly into applications and games. @@ -23,7 +23,7 @@ Check out our [Integrations](integrations/) to learn how to integrate this into ## How does it work? -We've built a special background service that pairs the ZeroTier protocol with a user-space [Lightweight IP (lwIP) stack](http://savannah.nongnu.org/projects/lwip/) to create a new way for you to bring your applications onto your virtual network. For a more in-depth explanation of our technology take a look at our [SDK Primer](docs/zt_sdk_primer.md) +We've built a special background tap service that pairs the ZeroTier protocol with swappable user-space network stacks. For our initial release we've provided drivers for [Lightweight IP (lwIP)](http://savannah.nongnu.org/projects/lwip/) and [picoTCP](http://www.picotcp.com/). The aim is to provide a new way for you to bring your applications onto your virtual network. For a more in-depth explanation of our technology take a look at our [SDK Primer](docs/zt_sdk_primer.md) ## APIs diff --git a/integrations/README.md b/integrations/README.md index 34ba887..db50c12 100644 --- a/integrations/README.md +++ b/integrations/README.md @@ -14,10 +14,15 @@ For more support on these integrations, or if you'd like help creating a new int *** ## Important Build flags +- `SDK_IPV4=1` - Enable IPv4 support in whatever stack you have selected +- `SDK_IPV6=1` - Enable IPv6 support in whatever stack you have selected + +- `SDK_LWIP=1` - Enable the use of `lwIP` +- `SDK_PICOTCP=1` - Enable the use of `picoTCP` + - `SDK_DEBUG=1` - Turns on SDK activity/warning/error output. Levels of verbosity can be adjusted in `src/SDK_Debug.h` -- `SDK_DEBUG_LOGFILE=1` - Used in conjunction with `SDK_DEBUG`, this will write all SDK debug chatter to a log file. To use this, set `make SDK_DEBUG_LOGFILE=1` then `export ZT_SDK_LOGFILE=debug.log`. -- `SDK_LWIP_DEBUG=1` - Turns on debug output for the lwIP library. -- `SDK_BUNDLED=1` - Builds the SDK as a single bundled target including a the RPC mechanism, the lwIP library, and the ZeroTier service. +- `SDK_LWIP_DEBUG=1` - Turns on debug output for the `lwIP` library. +- `SDK_BUNDLED=1` - Builds the SDK as a single bundled target including a the RPC mechanism, the `lwIP` library, and the ZeroTier service. *** ## Current Integrations