Ver Fonte

Adjusted readme and dockerfile

Signed-off-by: Michał Pełka <[email protected]>
Michał Pełka há 2 anos atrás
pai
commit
55e1a71d64
3 ficheiros alterados com 8 adições e 16 exclusões
  1. 2 2
      README.md
  2. 1 1
      docker/Dockerfile
  3. 5 13
      kraken_nav/README.md

+ 2 - 2
README.md

@@ -156,7 +156,7 @@ build/linux/bin/profile/Editor
 
 ## Building the Navigation package
 
-To build the ROS 2 navigation stack configured for this Project, please follow this [repository](https://github.com/RobotecAI/o3de_kraken_nav). Do not run it yet if you wish to follow the demo scenario.
+To build the ROS 2 navigation stack configured for this Project, please follow this [detailed document](kraken_nav/README.md). Do not run it yet if you wish to follow the demo scenario.
 
 # Running the demo scenario
 
@@ -166,7 +166,7 @@ You can try out the demo scenario as presented during ROSCon 2022. Take the foll
 2. Run the simulation with `Ctrl-G` or by pressing the Play button in the Editor. 
 3. When it loads, spawn your first Apple Kraken using the following command: `ros2 service call /spawn_entity gazebo_msgs/srv/SpawnEntity '{name: 'apple_kraken_rusty', xml: 'line1'}'`.
    1. You can learn more about spawning in [this section](#spawning-krakens)
-3. Once the simulation is running, start the [navigation stack](https://github.com/RobotecAI/o3de_kraken_nav). If you followed all the instructions for setting it up, do the following:
+3. Once the simulation is running, start the [navigation stack](kraken_nav/README.md). If you followed all the instructions for setting it up, do the following:
    1. launch the stack for the first robot with `ros2 launch o3de_kraken_nav navigation_multi.launch.py namespace:=apple_kraken_rusty_1 rviz:=True`. 
    1. You should see a new Rviz2 window.
    1. Note that the number index `_1` has been added to the namespace when it was automatically generated by the Spawner.

+ 1 - 1
docker/Dockerfile

@@ -142,7 +142,7 @@ WORKDIR $WORKDIR
 
 RUN mkdir -p o3de_kraken_ws/src \
     && cd o3de_kraken_ws/src \
-    && git clone https://github.com/RobotecAI/o3de_kraken_nav.git
+    && ln -s $WORKDIR/ROSConDemo/kraken_nav kraken_nav
 
 RUN cd o3de_kraken_ws \
     && colcon build --symlink-install

+ 5 - 13
kraken_nav/README.md

@@ -76,7 +76,7 @@ pip install python-statemachine
 
 ## Installation ##
 
-- Use the [roscon_2022](https://github.com/aws-lumberyard-dev/o3de/tree/roscon_2022) branch of the `O3DE`.
+- Use the [development](https://github.com/o3de/o3de/tree/development) branch of the `O3DE`.
 - Use the the [development](https://github.com/RobotecAI/o3de-ros2-gem/tree/development) branch of the `o3de-ros-gem`.
 - Use the [main](https://github.com/aws-lumberyard/ROSConDemo) branch of the `ROSConDemo`.
 
@@ -86,23 +86,16 @@ pip install python-statemachine
 source /opt/ros/humble/setup.bash
 ```
 
-2. Clone `o3de_kraken_nav` package to `src` directory inside a workspace directory (assumed `~/o3de_kraken_ws`), 
+2. Build the workspace
 
 ```bash
-mkdir -p ~/o3de_kraken_ws/src && cd ~/o3de_kraken_ws/src
-git clone https://github.com/RobotecAI/o3de_kraken_nav.git
-```
-
-3. Build the workspace
-
-```bash
-cd ~/o3de_kraken_ws
+cd ./kraken_nav
 colcon build --symlink-install
 ```
 
 ## Running simulation
 
-1. [Build](https://github.com/aws-lumberyard/ROSConDemo#download-and-install) and run the `ROSConDemo`
+1. [Build](https://github.com/o3de/ROSConDemo#download-and-install) and run the `ROSConDemo`
 2. Load level `Main`
 3. Start a simulation by hitting `CTRL+G`
 
@@ -116,8 +109,7 @@ You can consider adding it to your `~/.bashrc`.
 1. Make sure that you have ROS2 workspace sourced
 
 ```bash
-cd ~/o3de_kraken_ws
-source ./install/setup.bash
+source ./kraken_nav/install/setup.bash
 ```
 
 2. Make sure that you have `CycleDDS` as middleware