Change defaults, have rosdep instructions last

Signed-off-by: Ryan Friedman <[email protected]>
ArduPilot · Jun 24, 2024 · 939af67 · 939af67
1 parent 80cd862
commit 939af67
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 14 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -17,7 +17,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 # --------------------------------------------------------------------------- #
 # Find gz-sim and dependencies.
 
-# Harmonic
+# Harmonic (default)
 if("$ENV{GZ_VERSION}" STREQUAL "harmonic" OR NOT DEFINED "ENV{GZ_VERSION}")
   find_package(gz-cmake3 REQUIRED)
   set(GZ_CMAKE_VER ${gz-cmake3_VERSION_MAJOR})
@@ -32,7 +32,7 @@ if("$ENV{GZ_VERSION}" STREQUAL "harmonic" OR NOT DEFINED "ENV{GZ_VERSION}")
   set(GZ_SIM_VER ${gz-sim8_VERSION_MAJOR})
 
   message(STATUS "Compiling against Gazebo Harmonic")
-# Garden (default)
+# Garden
 elseif("$ENV{GZ_VERSION}" STREQUAL "garden")
   find_package(gz-cmake3 REQUIRED)
   set(GZ_CMAKE_VER ${gz-cmake3_VERSION_MAJOR})

diff --git a/README.md b/README.md
@@ -44,18 +44,7 @@ Install additional dependencies:
 
 ### Ubuntu
 
-Recommended - Use rosdep with
-[osrf's rosdep rules](https://github.com/osrf/osrf-rosdep?tab=readme-ov-file#1-use-rosdep-to-resolve-gazebo-libraries)
-to manage all dependencies. This is driven off of the environment variable `GZ_VERSION`.
-
-```bash
-export GZ_VERSION=harmonic # or garden
-sudo bash -c 'wget https://raw.githubusercontent.com/osrf/osrf-rosdep/master/gz/00-gazebo.list -O /etc/ros/rosdep/sources.list.d/00-gazebo.list'
-rosdep update
-rosdep resolve gz-harmonic
-# Navigate to your ROS workspace before the next command.
-rosdep install --from-paths src --ignore-src -y
-```
+#### Garden (apt)
 
 Manual - Gazebo Garden Dependencies:
 
@@ -64,13 +53,30 @@ sudo apt update
 sudo apt install libgz-sim7-dev rapidjson-dev
 ```
 
+#### Harmonic (apt)
+
 Manual - Gazebo Harmonic Dependencies:
 
 ```bash
 sudo apt update
 sudo apt install libgz-sim8-dev rapidjson-dev
 ```
 
+#### Rosdep
+
+Use rosdep with
+[osrf's rosdep rules](https://github.com/osrf/osrf-rosdep?tab=readme-ov-file#1-use-rosdep-to-resolve-gazebo-libraries)
+to manage all dependencies. This is driven off of the environment variable `GZ_VERSION`.
+
+```bash
+export GZ_VERSION=harmonic # or garden
+sudo bash -c 'wget https://raw.githubusercontent.com/osrf/osrf-rosdep/master/gz/00-gazebo.list -O /etc/ros/rosdep/sources.list.d/00-gazebo.list'
+rosdep update
+rosdep resolve gz-harmonic # or gz-garden
+# Navigate to your ROS workspace before the next command.
+rosdep install --from-paths src --ignore-src -y
+```
+
 ### macOS
 
 ```bash