From e219ccf5f9dcf9d67c3e8ebd14c897db7178e4b6 Mon Sep 17 00:00:00 2001 From: Johnson Sun Date: Thu, 24 Oct 2024 02:08:13 +0800 Subject: [PATCH] docs: Add badges --- docs/aloha-ws/index.md | 4 ++++ docs/cartographer-ws/index.md | 4 ++++ docs/gazebo-world-ws/index.md | 4 ++++ docs/husky-ws/index.md | 4 ++++ docs/kobuki-ws/index.md | 4 ++++ docs/orbslam3-ws/index.md | 4 ++++ docs/ros1-bridge-ws/index.md | 5 +++++ docs/rtabmap-ws/index.md | 4 ++++ docs/template-ws/index.md | 4 ++++ docs/vlp-ws/index.md | 4 ++++ 10 files changed, 41 insertions(+) diff --git a/docs/aloha-ws/index.md b/docs/aloha-ws/index.md index e4bcd0d9..411d9bc8 100644 --- a/docs/aloha-ws/index.md +++ b/docs/aloha-ws/index.md @@ -1,5 +1,9 @@ # ALOHA +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-aloha-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/aloha_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=aloha_ws)](https://github.com/j3soon/ros2-essentials/commits/main/aloha_ws) + ## Start Container ```sh diff --git a/docs/cartographer-ws/index.md b/docs/cartographer-ws/index.md index a3baa433..6e6b4435 100644 --- a/docs/cartographer-ws/index.md +++ b/docs/cartographer-ws/index.md @@ -1,5 +1,9 @@ # Cartographer +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-cartographer-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/cartographer_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=cartographer_ws)](https://github.com/j3soon/ros2-essentials/commits/main/cartographer_ws) + ### Run with docker ```bash diff --git a/docs/gazebo-world-ws/index.md b/docs/gazebo-world-ws/index.md index 45248dc8..36417665 100644 --- a/docs/gazebo-world-ws/index.md +++ b/docs/gazebo-world-ws/index.md @@ -1,5 +1,9 @@ # Gazebo World +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-gazebo-world-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/gazebo_world_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=gazebo_world_ws)](https://github.com/j3soon/ros2-essentials/commits/main/gazebo_world_ws) + This repository contains several Gazebo worlds, which are valuable for testing robots or agents in both indoor and outdoor environments. ## 🌱 Structure 🌱 diff --git a/docs/husky-ws/index.md b/docs/husky-ws/index.md index e5c3792c..f3fac56e 100644 --- a/docs/husky-ws/index.md +++ b/docs/husky-ws/index.md @@ -1,5 +1,9 @@ # Clearpath Husky +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-husky-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/husky_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=husky_ws)](https://github.com/j3soon/ros2-essentials/commits/main/husky_ws) + This repository will help you configure the environment for Husky quickly. ## 🌱 Structure 🌱 diff --git a/docs/kobuki-ws/index.md b/docs/kobuki-ws/index.md index 382ed0b2..9cee4c9d 100644 --- a/docs/kobuki-ws/index.md +++ b/docs/kobuki-ws/index.md @@ -1,5 +1,9 @@ # Yujin Robot Kobuki +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-kobuki-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/kobuki_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=kobuki_ws)](https://github.com/j3soon/ros2-essentials/commits/main/kobuki_ws) + This repository facilitates the quick configuration of the simulation environment and real robot driver for Kobuki. ## ◻️ Introduction ◻️ diff --git a/docs/orbslam3-ws/index.md b/docs/orbslam3-ws/index.md index 96a8a099..3e447393 100644 --- a/docs/orbslam3-ws/index.md +++ b/docs/orbslam3-ws/index.md @@ -1,5 +1,9 @@ # ORB-SLAM3 +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-orbslam3-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/orbslam3_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=orbslam3_ws)](https://github.com/j3soon/ros2-essentials/commits/main/orbslam3_ws) + ### Run with docker ```bash diff --git a/docs/ros1-bridge-ws/index.md b/docs/ros1-bridge-ws/index.md index 8ca13ffe..a630b3c0 100644 --- a/docs/ros1-bridge-ws/index.md +++ b/docs/ros1-bridge-ws/index.md @@ -1,5 +1,10 @@ # ROS1 Bridge +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-ros1-bridge-ws/tags) +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-ros1-bridge-build-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/ros1_bridge_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=ros1_bridge_ws)](https://github.com/j3soon/ros2-essentials/commits/main/ros1_bridge_ws) + This workspace is utilized to create a bridge between ROS1 and ROS2-humble. # ◻️ Introduction ◻️ diff --git a/docs/rtabmap-ws/index.md b/docs/rtabmap-ws/index.md index d74ee839..3c3b0ad9 100644 --- a/docs/rtabmap-ws/index.md +++ b/docs/rtabmap-ws/index.md @@ -1,5 +1,9 @@ # RTAB-Map +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-rtabmap-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/rtabmap_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=rtabmap_ws)](https://github.com/j3soon/ros2-essentials/commits/main/rtabmap_ws) + ### Run with docker ```bash diff --git a/docs/template-ws/index.md b/docs/template-ws/index.md index cf29b20e..ff61c6a7 100644 --- a/docs/template-ws/index.md +++ b/docs/template-ws/index.md @@ -1,5 +1,9 @@ # Template +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-template-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/template_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=template_ws)](https://github.com/j3soon/ros2-essentials/commits/main/template_ws) + This template will help you set up a ROS-Humble environment quickly. ## 🌱 Structure 🌱 diff --git a/docs/vlp-ws/index.md b/docs/vlp-ws/index.md index 6de9328a..e20ddf1f 100644 --- a/docs/vlp-ws/index.md +++ b/docs/vlp-ws/index.md @@ -1,5 +1,9 @@ # Velodyne VLP-16 +[![DockerHub image](https://img.shields.io/badge/dockerhub-image-important.svg?logo=docker)](https://hub.docker.com/r/j3soon/ros2-vlp-ws/tags) +[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/tree/main/vlp_ws) +[![GitHub last commit](https://img.shields.io/github/last-commit/j3soon/ros2-essentials?path=vlp_ws)](https://github.com/j3soon/ros2-essentials/commits/main/vlp_ws) + ## Simulation Setup ### Add description in defined robot