Skip to content

Commit 89d0d7f

Browse files
committed
Use different header markdown syntax
For more granularity in header levels. Signed-off-by: Jacob Perron <jacob@openrobotics.org>
1 parent 1be08b6 commit 89d0d7f

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

README.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
1-
ROS 2 Java client library
2-
=========================
1+
# ROS 2 Java client library
32

4-
Build status
5-
------------
3+
### Build status
64

75
| Target | Status |
86
|-------------------------------------------|---------------|
97
| **ROS Dashing - Ubuntu Bionic (OpenJDK)** | ![Build Status](https://github.com/ros2-java/ros2_java/workflows/CI/badge.svg?branch=dashing) |
108

11-
Introduction
12-
------------
9+
## Introduction
1310

1411
This is a set of projects (bindings, code generator, examples and more) that enables developers to write ROS 2
1512
applications for the JVM and Android.
@@ -20,18 +17,15 @@ Besides this repository itself, there's also:
2017
- https://github.com/ros2-java/ros2_java_examples, examples for the Java Runtime Environment
2118
- https://github.com/ros2-java/ros2_android_examples, examples for Android
2219

23-
Is this Java only?
24-
------------------
20+
### Is this Java only?
2521

2622
No, any language that targets the JVM can be used to write ROS 2 applications.
2723

28-
Including Android?
29-
------------------
24+
### Including Android?
3025

3126
Yep! Make sure to use Fast-RTPS as your DDS vendor and at least [this revision](https://github.com/eProsima/Fast-RTPS/commit/5301ef203d45528a083821c3ba582164d782360b).
3227

33-
Features
34-
--------
28+
### Features
3529

3630
The current set of features include:
3731
- Generation of all builtin and complex ROS types, including arrays, strings, nested types, constants, etc.
@@ -44,10 +38,9 @@ The current set of features include:
4438
- Support for Android
4539
- Parameters services and clients (both asynchronous and synchronous)
4640

47-
Sounds great, how can I try this out?
48-
-------------------------------------
41+
## Sounds great, how can I try this out?
4942

50-
Install dependencies
43+
### Install dependencies
5144

5245
> Note: While the following instructions use a Linux shell the same can be done on other platforms like Windows with slightly adjusted commands.
5346
@@ -89,10 +82,7 @@ Make sure you have Gradle 3.2 (or later) installed.
8982
python3 -m pip install -U git+https://github.com/colcon/colcon-gradle
9083
python3 -m pip install --no-deps -U git+https://github.com/colcon/colcon-ros-gradle
9184

92-
Desktop
93-
-------
94-
95-
Download and Build ROS 2 Java
85+
### Download and Build ROS 2 Java for Desktop
9686

9787
1. Source your ROS 2 installation, for example:
9888

@@ -112,8 +102,9 @@ Download and Build ROS 2 Java
112102

113103
colcon build --symlink-install
114104

115-
Android
116-
-------
105+
### Download and Build ROS 2 Java for Android
106+
107+
> TODO: This section needs updated instructions for ROS 2 Dashing and newer
117108
118109
The Android setup is slightly more complex, you'll need the SDK and NDK installed, and an Android device where you can run the examples.
119110

0 commit comments

Comments
 (0)