Bump version

Improved rosbag support
PRBonn · Apr 7, 2023 · 2762854 · 2762854
1 parent 8412fb6
commit 2762854
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 22 deletions.
diff --git a/cpp/kiss_icp/CMakeLists.txt b/cpp/kiss_icp/CMakeLists.txt
@@ -21,7 +21,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 cmake_minimum_required(VERSION 3.16...3.26)
-project(kiss_icp_cpp VERSION 0.2.5 LANGUAGES CXX)
+project(kiss_icp_cpp VERSION 0.2.6 LANGUAGES CXX)
 
 # Setup build options
 option(USE_SYSTEM_EIGEN3 "Use system pre-installed Eigen" ON)

diff --git a/python/CMakeLists.txt b/python/CMakeLists.txt
@@ -21,7 +21,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 cmake_minimum_required(VERSION 3.16...3.26)
-project(kiss_icp_pybind VERSION 0.2.5 LANGUAGES CXX)
+project(kiss_icp_pybind VERSION 0.2.6 LANGUAGES CXX)
 
 # Set build type
 set(CMAKE_BUILD_TYPE Release)

diff --git a/python/README.md b/python/README.md
@@ -1,17 +1,39 @@
-# KISS-ICP
-
-[![KISS-ICP demo](https://user-images.githubusercontent.com/21349875/211829074-474bec08-0129-4e34-85e7-62265e44a7de.png)](https://user-images.githubusercontent.com/21349875/219626075-d67e9165-31a2-4a1b-8c26-9f04e7d195ec.mp4
-)
-
-## Install Python API
-
-We released a python-package supported on
-![macos](https://img.shields.io/badge/-macos-333333?style=flat&logo=apple),
-![windows](https://img.shields.io/badge/windows-333333?style=flat&logo=windows&logocolor=blue), and
-![ubuntu](https://img.shields.io/badge/ubuntu-333333?style=flat&logo=ubuntu).
-
-
-To get started, just run
+<div align="center">
+    <h1>KISS-ICP</h1>
+    <a href="https://github.com/PRBonn/kiss-icp/releases"><img src="https://img.shields.io/github/v/release/PRBonn/kiss-icp?label=version" /></a>
+    <a href="https://github.com/PRBonn/kiss-icp/blob/main/LICENSE"><img src="https://img.shields.io/github/license/PRBonn/kiss-icp" /></a>
+    <a href="https://github.com/PRBonn/kiss-icp/blob/main/"><img src="https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black" /></a>
+    <a href="https://github.com/PRBonn/kiss-icp/blob/main/"><img src="https://img.shields.io/badge/Windows-0078D6?st&logo=windows&logoColor=white" /></a>
+    <a href="https://github.com/PRBonn/kiss-icp/blob/main/"><img src="https://img.shields.io/badge/mac%20os-000000?&logo=apple&logoColor=white" /></a>
+    <br />
+    <br />
+    <a href=https://user-images.githubusercontent.com/21349875/219626075-d67e9165-31a2-4a1b-8c26-9f04e7d195ec.mp4>Demo</a>
+    <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+    <a href="https://github.com/PRBonn/kiss-icp/edit/main/README.md#install">Install</a>
+    <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+    <a href="https://github.com/PRBonn/kiss-icp/blob/main/ros">ROS 1</a>
+    <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+    <a href="https://github.com/PRBonn/kiss-icp/blob/main/ros">ROS 2</a>
+    <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+    <a href=https://user-images.githubusercontent.com/21349875/214578180-b1d2431c-8fff-440e-aa6e-99a1d85989b5.mp4
+>ROS Demo</a>
+    <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+    <a href=https://www.ipb.uni-bonn.de/wp-content/papercite-data/pdf/vizzo2023ral.pdf>Paper</a>
+    <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+    <a href=https://github.com/PRBonn/kiss-icp/issues>Contact Us</a>
+  <br />
+  <br />
+
+[KISS-ICP](https://www.ipb.uni-bonn.de/wp-content/papercite-data/pdf/vizzo2023ral.pdf) is a LiDAR Odometry pipeline that **just works** on most of the cases withouth tunning any parameter.
+
+  <p align="center">
+    <a href="https://user-images.githubusercontent.com/21349875/219626075-d67e9165-31a2-4a1b-8c26-9f04e7d195ec.mp4"><img alt="KISS-ICP Demo" src="https://user-images.githubusercontent.com/21349875/211829074-474bec08-0129-4e34-85e7-62265e44a7de.png"></a>
+  </p>
+</div>
+
+<hr />
+
+## Install
 
 ```sh
 pip install kiss-icp
@@ -23,6 +45,8 @@ If you also want to install all the *(optional)* dependencies, like Open3D for r
 pip install "kiss-icp[all]"
 ```
 
+## Running the system
+
 Next, follow the instructions on how to run the system by typing:
 
 ```sh
@@ -68,7 +92,7 @@ If you use this library for any academic work, please cite our original [paper](
   author    = {Vizzo, Ignacio and Guadagnino, Tiziano and Mersch, Benedikt and Wiesmann, Louis and Behley, Jens and Stachniss, Cyrill},
   title     = {{KISS-ICP: In Defense of Point-to-Point ICP -- Simple, Accurate, and Robust Registration If Done the Right Way}},
   journal   = {IEEE Robotics and Automation Letters (RA-L)},
-  pages     = {1-8},
+  pages     = {1029--1036},
   doi       = {10.1109/LRA.2023.3236571},
   volume    = {8},
   number    = {2},
@@ -77,6 +101,11 @@ If you use this library for any academic work, please cite our original [paper](
 }
 ```
 
-## Star History
+## Contributing
+
+We envision KISS-ICP as a comunity-driven project, we love to see how the project is growing thanks to the contributions from the comunity. We would love to see your face in the list below, just open a Pull Request!
 
+<a href="https://github.com/PRBonn/kiss-icp/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=PRBonn/kiss-icp" />
+</a>
 [![Star History Chart](https://api.star-history.com/svg?repos=PRBonn/kiss-icp&type=Date)](https://star-history.com/#PRBonn/kiss-icp&Date)
diff --git a/python/kiss_icp/__init__.py b/python/kiss_icp/__init__.py
@@ -20,4 +20,4 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-__version__ = "0.2.5"
+__version__ = "0.2.6"
diff --git a/python/setup.cfg b/python/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = kiss_icp
-version = 0.2.5
+version = 0.2.6
 author = Ignacio Vizzo
 author_email = [email protected]
 description = Simple yet effective 3D LiDAR-Odometry registration pipeline

diff --git a/ros/CMakeLists.txt b/ros/CMakeLists.txt
@@ -21,7 +21,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 cmake_minimum_required(VERSION 3.16...3.26)
-project(kiss_icp VERSION 0.2.5 LANGUAGES CXX)
+project(kiss_icp VERSION 0.2.6 LANGUAGES CXX)
 
 set(ignore ${CATKIN_INSTALL_INTO_PREFIX_ROOT})
 set(CMAKE_BUILD_TYPE Release)

diff --git a/ros/package.xml b/ros/package.xml
@@ -25,7 +25,7 @@
 -->
 <package format="3">
   <name>kiss_icp</name>
-  <version>0.2.5</version>
+  <version>0.2.6</version>
   <description>KISS-ICP ROS Wrappers</description>
   <maintainer email="[email protected]">ivizzo</maintainer>
   <license>MIT</license>