From 7ce3358385dfdf95fdc63727271390e559d1f329 Mon Sep 17 00:00:00 2001 From: Victor Reijgwart Date: Thu, 5 Oct 2023 16:33:17 +0200 Subject: [PATCH 1/7] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index af3dc3b5c..4eac29922 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # Wavemap - +[![tests](https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/ci.yml?label=tests&logo=githubactions&logoColor=white)](https://github.com/ethz-asl/wavemap/actions/workflows/ci.yml) +[![deployment](https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/ci.yml?label=deployment&logo=githubactions&logoColor=white)](https://github.com/ethz-asl/wavemap/actions/workflows/cd.yml) +[![docs](https://img.shields.io/badge/docs-online-brightgreen?logo=sphinx)](https://ethz-asl.github.io/wavemap/) +[![release](https://img.shields.io/github/v/tag/ethz-asl/wavemap?label=release&logo=github)](https://github.com/ethz-asl/wavemap/releases) +[![license](https://img.shields.io/badge/license-BSD%203-blue?logo=bsd)](https://github.com/ethz-asl/wavemap/blob/main/LICENSE) +[![linux](https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black)](https://ethz-asl.github.io/wavemap/pages/installation.html) +[![docker](https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=black)](https://github.com/ethz-asl/wavemap/pkgs/container/wavemap) +[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)]([https://github.com/dwyl/esta/issues](https://github.com/ethz-asl/wavemap/issues)) ![3D reconstruction of Newer College's Cloister](https://github.com/ethz-asl/wavemap/assets/6238939/0df66963-3871-4fae-8567-523518c43494) ## Hierarchical, multi-resolution volumetric mapping @@ -8,6 +15,8 @@ Wavemap achieves state-of-the-art memory and computational efficiency by combini The framework is very flexible and supports several data structures, measurement integration methods, and sensor models out of the box. The ROS interface can, for example, easily be configured to fuse multiple sensor inputs, such as a LiDAR configured with a range of 20m and several depth cameras up to a resolution of 1cm, into a single map. +⭐ If you find wavemap useful, consider starring it on GitHub to be notified of new releases! + ## Documentation The framework's documentation is hosted on [GitHub Pages](https://ethz-asl.github.io/wavemap/). From 35f7ade0de73193270e17aae4e732e895a4bba54 Mon Sep 17 00:00:00 2001 From: Victor Reijgwart Date: Thu, 5 Oct 2023 17:08:44 +0200 Subject: [PATCH 2/7] Improve badge layout --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4eac29922..13ffc85b0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,20 @@ # Wavemap -[![tests](https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/ci.yml?label=tests&logo=githubactions&logoColor=white)](https://github.com/ethz-asl/wavemap/actions/workflows/ci.yml) -[![deployment](https://img.shields.io/github/actions/workflow/status/ethz-asl/wavemap/ci.yml?label=deployment&logo=githubactions&logoColor=white)](https://github.com/ethz-asl/wavemap/actions/workflows/cd.yml) -[![docs](https://img.shields.io/badge/docs-online-brightgreen?logo=sphinx)](https://ethz-asl.github.io/wavemap/) -[![release](https://img.shields.io/github/v/tag/ethz-asl/wavemap?label=release&logo=github)](https://github.com/ethz-asl/wavemap/releases) -[![license](https://img.shields.io/badge/license-BSD%203-blue?logo=bsd)](https://github.com/ethz-asl/wavemap/blob/main/LICENSE) -[![linux](https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black)](https://ethz-asl.github.io/wavemap/pages/installation.html) -[![docker](https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=black)](https://github.com/ethz-asl/wavemap/pkgs/container/wavemap) -[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)]([https://github.com/dwyl/esta/issues](https://github.com/ethz-asl/wavemap/issues)) +
+test +deploy +docs +release +license +contributions welcome +
+
+linux +docker +intel +amd +arm +
+ ![3D reconstruction of Newer College's Cloister](https://github.com/ethz-asl/wavemap/assets/6238939/0df66963-3871-4fae-8567-523518c43494) ## Hierarchical, multi-resolution volumetric mapping From 7f098b2d2f57447a5cd9f3b7087cdc8e66148362 Mon Sep 17 00:00:00 2001 From: Victor Reijgwart Date: Thu, 5 Oct 2023 17:13:21 +0200 Subject: [PATCH 3/7] Address linter errors --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 13ffc85b0..cd8a3c791 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ docker intel amd -arm +arm ![3D reconstruction of Newer College's Cloister](https://github.com/ethz-asl/wavemap/assets/6238939/0df66963-3871-4fae-8567-523518c43494) From 194c59f2534d5ce2f136e39ae3cf05d0e2cb9842 Mon Sep 17 00:00:00 2001 From: Victor Reijgwart Date: Thu, 5 Oct 2023 17:21:26 +0200 Subject: [PATCH 4/7] Capitalize company names correctly --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cd8a3c791..cb755f236 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@
linux docker -intel -amd -arm +Intel +AMD +Arm
![3D reconstruction of Newer College's Cloister](https://github.com/ethz-asl/wavemap/assets/6238939/0df66963-3871-4fae-8567-523518c43494) From 833e631a5aaa3a6af36c497add8adf2a74d502d2 Mon Sep 17 00:00:00 2001 From: Victor Reijgwart Date: Thu, 5 Oct 2023 17:30:09 +0200 Subject: [PATCH 5/7] Change contributing badge link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cb755f236..abfd7752d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ docs release license -contributions welcome +contributions welcome
linux From 3cde96d15211995db1eb92f7bdf31e113dff69cd Mon Sep 17 00:00:00 2001 From: Victor Reijgwart Date: Thu, 5 Oct 2023 17:57:03 +0200 Subject: [PATCH 6/7] Remove Linux badge, as the code is not platform dependent --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index abfd7752d..d1c5b7189 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,10 @@ contributions welcome
-linux -docker Intel AMD Arm +docker
![3D reconstruction of Newer College's Cloister](https://github.com/ethz-asl/wavemap/assets/6238939/0df66963-3871-4fae-8567-523518c43494) From 99e68244f89fcdbdc856b40eb95feb397a08d181 Mon Sep 17 00:00:00 2001 From: Victor Reijgwart Date: Thu, 5 Oct 2023 18:31:10 +0200 Subject: [PATCH 7/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d1c5b7189..1fdd73274 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Wavemap achieves state-of-the-art memory and computational efficiency by combini The framework is very flexible and supports several data structures, measurement integration methods, and sensor models out of the box. The ROS interface can, for example, easily be configured to fuse multiple sensor inputs, such as a LiDAR configured with a range of 20m and several depth cameras up to a resolution of 1cm, into a single map. -⭐ If you find wavemap useful, consider starring it on GitHub to be notified of new releases! +⭐ If you find wavemap useful, star it on GitHub to get notified of new releases! ## Documentation The framework's documentation is hosted on [GitHub Pages](https://ethz-asl.github.io/wavemap/).