Change: modify README.md

README.md

@@ -1 +1,19 @@
-# KdTree
+# Notes
+1. It's based on nanoflann: https://github.com/jlblancoc/nanoflann.
+2. StaticKdTree3d is similar to pcl::PointCloud<pcl::PointXYZ> but faster.
+3. DynamicKdTree3d supports for dynamic updating(i.e. 3d pointcloud map updating).
+4. Since nanoflann is a C++11 header-only library, you can just copy the hpp files and test/use it.
+
+
+# Building 
+1.  install the Eigen3
+2.  cd ~/catkin_ws/src  
+    git clone https://github.com/G3tupup/KdTree.git  
+    cd ..  
+    catkin_make -DCMAKE_BUILD_TYPE=release
+    or  
+    you can compile dynamic_kd_tree_3d_example.cpp and static_kd_tree_3d_example.cpp in anyway you like.
+
+# Run
+cd ~/catkin_ws/devel/lib/kdtree  
+./dynamic_kd_tree_3d_example and ./dynamic_kd_tree_3d_example