Skip to content

Commit

Permalink
minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
KalanaRatnayake committed Jun 24, 2024
1 parent 775cfdb commit ed6792f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 11 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/kobuki_jammy_humble.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
name: ROS Humble Kobuki Control stack

on:
workflow_dispatch:

push:
branches:
- main
Expand Down
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Kobuki ROS2 package

This repository and the [dependencies repository](https://github.com/AIResearchLab/kobuki_dependencies.git) focuses on merging all the public forks available on the original [Kobuki Base](https://github.com/kobuki-base) repositories and extending the work towards an complete ROS2 package for kobuki based turtlebot robots. Additionally a Dockerfile for kobuki system has been provided that supports both ARM64 and AMD64 systems.
This repository and the [dependencies repository](https://github.com/AIResearchLab/kobuki_dependencies.git) focuses on merging all the public forks available on the original [Kobuki Base](https://github.com/kobuki-base) repositories and extending the work towards an complete ROS2 package for kobuki based turtlebot robots. Additionally a Dockerfile and prebuilt containers for kobuki system has been provided that supports both ARM64 and AMD64 systems.

## Docker Usage

Expand All @@ -27,14 +27,10 @@ Clone this reposiotory
git clone https://github.com/AIResearchLab/kobuki.git
```

Pull the Docker image and run Docker compose (No need to run `docker compose build`)
Pull the Docker image and start compose (No need to run `docker compose build`)
```bash
cd kobuki/docker
docker compose pull
```

Start the docker container
```bash
docker compose up
```

Expand All @@ -46,14 +42,10 @@ Clone this reposiotory
git clone https://github.com/AIResearchLab/kobuki.git
```

Build the Docker image
Build the Docker image and start compose
```bash
cd kobuki/docker
docker compose -f compose-build.yaml build
```

Start the docker container
```bash
docker compose -f compose-build.yaml up
```

Expand Down

0 comments on commit ed6792f

Please sign in to comment.