top-level README

README.txt

@@ -0,0 +1,43 @@
+
+Octomap
+- A probabilistic, flexible, and compact 3D mapping library for robotic systems.
+
+Authors: K. M. Wurm, A. Hornung, University of Freiburg, Copyright (C) 2009-2011.
+http://octomap.sourceforge.net/
+
+Further Contributors:
+S. Osswald, University of Freiburg
+R. Schmitt, University of Freiburg
+R. Bogdan Rusu, Willow Garage Inc.
+
+License: 
+  * New BSD License (see "octomap/LICENSE.txt")
+  * GPL for the viewer "octovis" and related libraries (see "octovis/LICENSE.txt").
+
+OVERVIEW
+############################
+
+OctoMap now consists of two separated libraries each in its own subfolder:
+octomap, the actual library, and octovis, our visualization libraries and tools.
+
+You can build each separately with CMake by running it from the subdirectories, 
+or build octomap and octovis together from this top-level directory. E.g., to
+only compile the library, run:
+
+  cd octomap
+  mkdir build
+  cd build
+  cmake ..
+  make
+
+To compile the complete package, run:
+  cd build
+  cmake ..
+  make
+
+Binaries and libs will end up in the directories "bin" and "lib" of the 
+top-level directory where you started the build.
+
+
+See "octomap/README.txt" for details about compilation.
+A list of changes is available in "octomap/CHANGELOG.txt"