Skip to content

Commit

Permalink
Updated docs and added rosdep alias
Browse files Browse the repository at this point in the history
- Added warning tags instead of requirement lines.
- Added the alias for rosdep update and rosdep install
	rosdep update: rosdepu
	rosdep install: rosdepi
  • Loading branch information
Oguzhan Bozoglu committed Nov 8, 2024
1 parent 30898d0 commit 85bab05
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
23 changes: 14 additions & 9 deletions docs/tutorials/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@ Clone and source the RosTeamWorkspace
setup-auto-sourcing # Make RosTeamWorkspace automatically sourced when open a new terminal (The best experience)
.. warning::
Before move to the next setup be aware of that **RTW work only ament_cmake build option**.
If you create a python packages, you will get cmake error and cannot run the launch files.
Always choice the **amet_cmake**.

Create new package in an existing workspace
--------------------------------------------------------
For more details check :ref:`use-case description <uc-new-package>`.
Expand All @@ -43,7 +38,14 @@ Create robot description package
-------------------------------------------------
For more details check :ref:`use-case description <uc-setup-robot-description>`.

requirement: have a <my_cool_robot_description_package_name> package to hold the robot description
.. warning::

You must have a <my_cool_robot_description_package_name> package to hold the robot description.

Before move to the next setup be aware of that **RTW work only ament_cmake build option**.
If you create a python packages, you will get cmake error and cannot run the launch files.
Always choice the **amet_cmake**.


.. code-block:: bash
Expand All @@ -57,7 +59,8 @@ Create robot bringup package
-----------------------------------------------
For more details check :ref:`use-case description <uc-setup-robot-bringup>`.

requirement: have a <my_cool_robot_bringup_package_name> package to hold the robot bringup
.. warning::
You must have a <my_cool_robot_bringup_package_name> package to hold the robot bringup.

.. code-block:: bash
Expand All @@ -71,7 +74,8 @@ Setup ros2_control control hardware
-------------------------------------------------
For more details check :ref:`use-case description <uc-setup-ros2-control-hardware>`.

requirement: have a <my_cool_robot_control_package_name> package to hold the robot's ros2_control hardware interface
.. warning::
You must have a <my_cool_robot_control_package_name> package to hold the robot's ros2_control hardware interface.

.. code-block:: bash
Expand All @@ -85,7 +89,8 @@ Setup ros2_control controller
-----------------------------------------------
For more details check :ref:`use-case description <uc-setup-ros2-controller>`.

requirement: have a <my_cool_robot_controller_package_name> package to hold the robot's ros2_control controller
.. warning::
You must have a <my_cool_robot_controller_package_name> package to hold the robot's ros2_control controller.

.. code-block:: bash
Expand Down
2 changes: 2 additions & 0 deletions scripts/_RosTeamWs_Defines.bash
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ function RosTeamWS_setup_aliases {
alias rosds="cd \$ROS_WS/src"
alias rosdb="cd \$ROS_WS/build"
alias rosdi="cd \$ROS_WS/install"
alias rosdepu="rosdep update"
alias rosdepi="cd \$ROS_WS/src && rosdep install --from-paths . -y -i"
}

function RosTeamWS_setup_ros1_exports {
Expand Down

0 comments on commit 85bab05

Please sign in to comment.