Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kaiaai authored Oct 26, 2023
1 parent dad8fc2 commit 3cc9860
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This repo is an Arduino Micro-ROS library for [Kaia.ai](https://kaia.ai) home pe
- Navigate to the [release section](https://github.com/kaiaai/micro_ros_arduino_kaia/releases), expand Assets
and download the latest `Source code (zip)` release
- Launch your Arduino IDE, open the Sketch -> Include library -> Add .ZIP Library... menu and
select the downloaded file named `micro_ros_arduino_kaia-2.0.7-rolling.zip` (the actual version digits may differ)
select the downloaded file named `micro_ros_arduino_kaia-2.0.7-humble.zip` (the actual version digits may differ)

## Install library using git
Alternatively, you can `git clone` this library as follows. This method may be useful if you need to edit library files or check out different versions of the library.
Expand All @@ -26,7 +26,7 @@ e.g. `C:\Users\YOUR-USER-NAME\Documents\Arduino\libraries`
- run commands below in a Windows shell to clone this library to your Windows PC
```
cd %HOMEPATH%\Documents\Arduino\libraries
git clone -b rolling --depth 1 https://github.com/kaiaai/micro_ros_arduino_kaiaai micro_ros_kaia
git clone -b humble --depth 1 https://github.com/kaiaai/micro_ros_arduino_kaiaai micro_ros_kaia
```
Now you can include this library into your sketch using `#include <micro_ros_kaia.h>`.

Expand All @@ -37,14 +37,14 @@ In some cases, tayloring [Kaia.ai](https://kaia.ai) software to your particular
- Open a Windows command shell and run these commands to rebuild the library using the [Micro-ROS library builder](https://github.com/micro-ROS/micro_ros_arduino):
```
cd %HOMEPATH%\Documents\Arduino\libraries
git clone -b rolling --depth 1 https://github.com/kaiaai/micro_ros_arduino_kaiaai micro_ros_kaia
docker run -it --rm -v .\micro_ros_kaia:/project --env MICROROS_LIBRARY_FOLDER=extras microros/micro_ros_static_library_builder:rolling
git clone -b humble --depth 1 https://github.com/kaiaai/micro_ros_arduino_kaiaai micro_ros_kaia
docker run -it --rm -v .\micro_ros_kaia:/project --env MICROROS_LIBRARY_FOLDER=extras microros/micro_ros_static_library_builder:humble
```

## Hints
- You can also rebuild the library for a particular platform only, e.g. for ESP32:
```
docker run -it --rm -v .\micro_ros_kaia:/project --env MICROROS_LIBRARY_FOLDER=extras microros/micro_ros_static_library_builder:rolling -p esp32
docker run -it --rm -v .\micro_ros_kaia:/project --env MICROROS_LIBRARY_FOLDER=extras microros/micro_ros_static_library_builder:humble -p esp32
```

## Acknowledgements and modifications
Expand Down

0 comments on commit 3cc9860

Please sign in to comment.