Skip to content

Commit

Permalink
README - mention melodic branch and git submodules
Browse files Browse the repository at this point in the history
  • Loading branch information
bjsowa committed Feb 21, 2022
1 parent e9c3520 commit 0cdcaec
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@ The main functionalities include:

It uses [rosserial] client library to expose its functionalities on ROS topics, services and parameters.

The v2.0.0+ releases are targeting ROS Noetic distribution. For development targeting ROS Melodic distribution, checkout the [melodic] branch.

## Building and flashing
This repository uses git submodules for external libraries, so make sure you clone this repository with `--recurse-submodules` option or, if you cloned without this option, initialize the missing submodules by typing:
```
git submodule update --init
```
To build the project you will need to install cmake and GNU Arm Embedded Toolchain. On Ubuntu/Debian, you can do:
```
sudo apt-get install cmake gcc-arm-none-eabi
Expand All @@ -36,7 +42,7 @@ rosrun leo_fw flash leo_firmware.bin
```

### Using Husarion extension for VSCode
You can also use the VSCode extension which already contains the Husarion SDK. This should work on Windows, Linux and MacOS platforms, but unfortunately break the VSCode IntelliSense configuration.
You can also use the VSCode extension which already contains the Husarion SDK. This should work on Windows, Linux and MacOS platforms, but unfortunately breaks the VSCode IntelliSense configuration.

Make sure you have installed:
- [Visual Studio Code],
Expand All @@ -59,4 +65,5 @@ For the information about exposed ROS topics, services and parameters, visit [le
[Husarion extension]: https://marketplace.visualstudio.com/items?itemName=husarion.husarion
[Husarion CORE2]: https://husarion.com/manuals/core2/
[rosserial]: http://wiki.ros.org/rosserial
[Husarion SDK]: http://files.fictionlab.pl/husarion/Husarion_SDK-stable.zip
[Husarion SDK]: http://files.fictionlab.pl/husarion/Husarion_SDK-stable.zip
[melodic]: https://github.com/LeoRover/core2_firmware/tree/melodic

0 comments on commit 0cdcaec

Please sign in to comment.