diff --git a/README.md b/README.md index 0c5d759..e7f8992 100644 --- a/README.md +++ b/README.md @@ -20,42 +20,42 @@ The reasons for installing ROS2 Jazzy natively on Apple Silicon Macbooks are: - To avoid any potential issues that may arise from using Rosetta 2 ## What it Does -- ROS2 Jazzy Installation (`install.sh`) - - 1. Checking System Requirements +### ROS2 Jazzy Installation (`install.sh`) + 1. Checking System Requirements - Check XCode Installation - Check Brew Installation - Generate workspace for ROS2 Jazzy (default: `~/ros2_jazzy`) - - 2. Install Dependencies + 2. Install Dependencies - Install dependencies with Brew - Set environment variables for Brew packages - Create a Python 3.11 virtual environment (default `~/.ros2_venv`) - Install Python dependencies - - 3. Download ROS2 Jazzy Source Code + 3. Download ROS2 Jazzy Source Code - Clone the ROS2 Jazzy source code - It's using release tag (default: `release-jazzy-20240523`) - Partial compile to generate structure - - 4. Patch for macOS X Installation + 4. Patch for macOS X Installation - Patch for cyclondds, orocos-kdl, rviz_ogre_vendor, rosbag2_transport - Ensure link with qt5 - Revert python_orocos_kdl_vendor back to 0.4.1 - Remove eclipse-cyclonedds - - 5. Compile ROS2 Jazzy - - 6. Post Installation + 5. Compile ROS2 Jazzy + 6. Post Installation - Generate a config file in the workspace - Make source script -- Gazebo Harmonic Installation (`gz_install.sh`) - - 1. Checking System Requirements +### Gazebo Harmonic Installation (`gz_install.sh`) + 1. Checking System Requirements - Create a workspace for Gazebo Harmonic (default: `~/gz_harmonic`) - Check the Python virtual environment - - 2. Install Dependencies + 2. Install Dependencies - Install Brew dependencies - Install Python dependencies - Set environmetnal variables for brew packages - Install xquartz - - 3. Download Gazebo Harmonic Source Code + 3. Download Gazebo Harmonic Source Code - Clone Gazebo Harmonic Source Code - - 4. Compile Gazebo Harmonic - - 5. Post Installation + 4. Compile Gazebo Harmonic + 5. Post Installation - Read/append to the config file in the workspace - Regenerate source script