From 48197955431992c02e7ea2e487862b732c070a19 Mon Sep 17 00:00:00 2001 From: Raghava Uppuluri Date: Mon, 19 Feb 2024 19:03:20 -0500 Subject: [PATCH] readme changes + simplify gazebo setup --- lunabot_sim/mining_arena_gazebo | 2 +- readme.md | 32 +++++++++++++++++++++----------- 2 files changed, 22 insertions(+), 12 deletions(-) diff --git a/lunabot_sim/mining_arena_gazebo b/lunabot_sim/mining_arena_gazebo index 79151a3c..8ec6e256 160000 --- a/lunabot_sim/mining_arena_gazebo +++ b/lunabot_sim/mining_arena_gazebo @@ -1 +1 @@ -Subproject commit 79151a3c8bf2fd9ffdda52c65f5dd8dccc721d81 +Subproject commit 8ec6e2568ec191e49aaefa21e263063edff22d6d diff --git a/readme.md b/readme.md index 6663c8b2..fefc41ee 100644 --- a/readme.md +++ b/readme.md @@ -2,14 +2,21 @@ This is the official git repo of the Purdue Lunabotics software team. -## Supported Platforms -- Ubuntu 20.04 -- if on windows: - - Use WSL2 (caveat: gui will appear more laggy) - - dual boot linux (caveat: can be hard to set up, not recommended for beginners) -- mac or windows (not tested): - - [try robostack to install ROS](https://robostack.github.io/GettingStarted.html) - - Once you complete this, move to step 2 +## Supported Platforms Out of the Box +- Fully-supported + - Ubuntu 20.04 +- Partly-supported + - Windows: + - Use WSL2 (caveat: gui will appear more laggy) + - Dual boot linux (caveat: can be hard to set up, not recommended for beginners) +- Not supported + - MacOS (both Intel and M1) + +## Other installation methods +- Docker (native support coming soon), adds support for MacOS and Windows + - [Get docker](https://docs.docker.com/get-docker/) + - [Use this ROS noetic Docker image (choose arm if you're on M1 Mac)](https://hub.docker.com/layers/library/ros/noetic/images/sha256-41a0aad743d47e08bec68cf48005706c27a3d7aad10632d204cada99ef3642b2?context=explore) + - [Useful docker-ros tutorial for learning how docker can be used with ROS](https://roboticseabass.com/2021/04/21/docker-and-ros/) ## Getting started @@ -32,9 +39,11 @@ This tutorial assumes you have your `catkin_ws` initialized in your home directo ``` cd ~/catkin_ws/src -git clone https://github.com/PurdueLunabotics/purdue_lunabotics.git +git clone --recurse-submodules https://github.com/PurdueLunabotics/purdue_lunabotics.git ``` +> Note: if you forgot to add recurse, run: `git submodule update --init --recursive --remote` + 3. Install dependencies at the root of your catkin workspace ``` cd ~/catkin_ws @@ -57,13 +66,14 @@ source ~/catkin_ws/devel/setup.bash # or .zsh if you use a zsh terminal ``` roslaunch lunabot_bringup sim.launch ``` - > you should see two new windows pop up: once called gazebo and one called rviz +> NOTE: to remove the TF_REPEATED lines run:`{ roslaunch lunabot_bringup sim.launch verbose:=true 2>&1 | grep -Ev 'TF_REPEATED_DATA|buffer_core|at line|^$'; } 2>&1` -2. Set goal waypoint and watch the robot navigate +2. Set goal waypoint in rviz and watch the robot navigate ## Important docs to read - [contributing guidelines](https://github.com/PurdueLunabotics/purdue_lunabotics/blob/master/contributing.md) - [running_the_robot](https://github.com/PurdueLunabotics/purdue_lunabotics/blob/master/running_the_robot.md) - [firmware setup](https://github.com/PurdueLunabotics/purdue_lunabotics/blob/master/lunabot_embedded/readme.md) +- [simulated arena docs](https://github.com/PurdueLunabotics/mining_arena_gazebo/blob/master/README.md)