added README

voxel-server/src/README

@@ -0,0 +1,80 @@
+NAME
+        voxel-server - the High Fidelity Voxel Server
+
+SYNOPSIS
+       voxel-server [--local] [--jurisdictionFile <filename>] [--port <port>] [--voxelsPersistFilename <filename>] 
+                    [--displayVoxelStats] [--debugVoxelSending] [--debugVoxelReceiving] [--shouldShowAnimationDebug]
+                    [--wantColorRandomizer] [--NoVoxelPersist] [--packetsPerSecond <value>] 
+                    [--AddRandomVoxels] [--AddScene] [--NoAddScene]
+
+DESCRIPTION
+       voxel-server is a compact, portable, scalable, distributed sparse voxel octree server
+
+OPTIONS
+
+  --local 
+        This will run the voxel server in "local domain mode" and will look for a domain-server running on the same IP
+        address as the voxel server
+              
+  --jurisdictionFile [filename]
+        Tells the server to load it's jurisdiction from the specified file. When a voxel server is running with a limited
+        "jurisdiction" it will only server voxels from that portion of the voxel tree. The jurisdiction file is a ".ini" style
+        file with the following options: [General/root] specifies the octal code for the node in the tree that this server will
+        use as it's "root". It will only server voxels under this root. [endNodes/...] a list or group of additional octalcodes
+        under the root, which will not be served.
+
+        The following example jurisdiction file will server all voxels from the root and below, and exclude voxels from the 
+        voxel of scale 0.25 and 0,0,0.
+        
+        ****** example jurisdiction.ini **********************************************************************
+        [General]
+        root=00
+
+        [endNodes]
+        endnode0=0200
+
+        ******************************************************************************************************
+
+  
+   --port [port]
+        Specify the port the voxel-server will listen on. You must specify different ports to enable multiple voxel servers
+        running on a single machine.
+        
+    --voxelsPersistFilename [filename]
+        Specify and alternate file that the voxel server will read and write persistant voxels to. By default the voxel server
+        will use one of the following files:
+
+            default:        /etc/highfidelity/voxel-server/resources/voxels.svo
+            in local mode:  ./resources/voxels.svo
+        
+    --displayVoxelStats
+        Displays additional voxel stats debugging
+        
+    --debugVoxelSending
+        Displays additional voxel sending debugging
+        
+    --debugVoxelReceiving
+        Displays additional voxel receiving debugging
+    
+    --shouldShowAnimationDebug
+        Displays additional verbose animation debugging
+
+    --wantColorRandomizer
+        Adds color randomization to inserts into the local voxel tree
+
+    --NoVoxelPersist
+        Disables voxel persisting
+        
+    --packetsPerSecond [value]
+        Specifies the packets per second that this voxel server will send to attached clients
+
+    --AddRandomVoxels
+        Add random voxels to the surface on startup
+        
+    --AddScene 
+        OBSOLETE: Adds an arbitrary scene with several "planet" spheres
+
+    --NoAddScene
+        OBSOLETE: disables adding of scene
+        
+