Adam Ierymenko 12 years ago
parent
commit
5df6055169
3 changed files with 27 additions and 15 deletions
  1. 4 11
      AUTHORS.txt
  2. 15 1
      BUILDING.txt
  3. 8 3
      RUNNING.txt

+ 4 - 11
AUTHORS.txt

@@ -1,15 +1,8 @@
-This file will track authors and contributors to ZeroTier's code base.
-People who contribute new code or bug fixes that are accepted into
-the master (trunk) branch will be credited here.
+ZeroTier One is designed and written by Adam Ierymenko, with a few bug
+fixes and other contributions from other users. Information about all
+contributors can be found on the GitHub home page at:
 
---
-
-Adam Ierymenko [[email protected]]
- * Principal author and maintainer of ZeroTier One, author of all
-   code prior to ZeroTier's open source release.
- * Maintainer of master branch, release manager.
-
---
+https://github.com/zerotier/ZeroTierOne
 
 ZeroTier One includes or links with the following third party software:
 

+ 15 - 1
BUILDING.txt

@@ -20,4 +20,18 @@ Edit Makefile.linux if you want to change between debug or release build.
 
 -- Windows
 
-TBD
+Right now Windows builds using Visual Studio 2012. Technically it should also
+build with other tools, but VS2012 is what your author is using.
+
+Load the ZeroTierOne.sln solution. Typically you won't need to worry about
+any projects other than ZeroTierOne, Service, and InstallerUpdater. SelfTest
+builds the selftest program which can be used to test many aspects of the
+core code base. TapDriver builds the Ethernet tap driver, which shouldn't
+be something end users need to do and requires a driver signing key to create
+a publishable driver that users can load without big red warnings.
+
+To just test ZeroTier One itself, build ZeroTierOne and run the binary in
+an administrator-mode command window.
+
+Instructions for doing a full build will be forthcoming once all the details
+are worked out. Windows is still a work in progress.

+ 8 - 3
RUNNING.txt

@@ -16,8 +16,9 @@ the kext there. Note that the kext must be owned by root:wheel. The make
 rule for install-mac-tap takes care of that.
 
 Next, simply run the binary. It must be run as root to open the tap device.
+If run with no options, it will use the default home directory above.
 
-sudo ./zerotier-one '/Library/Application Support/ZeroTier/One' &
+sudo ./zerotier-one &
 
 Type "ifconfig" and look for the new interface, which should be called
 "zt0." The strange IPv4 address it has is your "zero4" address. Visit
@@ -37,11 +38,15 @@ We use the Linux native tap driver, so no special drivers are needed. Just
 type:
 
 sudo mkdir /var/lib/zerotier-one
-sudo ./zerotier-one /var/lib/zerotier-one &
+sudo ./zerotier-one &
+
+When run with no options, ZT1 uses its default home path on the current
+platform.
 
 Type ifconfig and you should see an interface like "zt0." Then try
 http://zerotier.net or ping zerotier.net to check your connection.
 
 -- Windows
 
-TBD
+To run for manual testing, build the ZeroTierOne VS2012 project and run it
+in an administrator-privileged command prompt window.