Skip to content

Commit

Permalink
docs: update README and dependency hierarcy diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
zhivkopetrov committed Sep 9, 2022
1 parent 01df964 commit 7022de5
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 4 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The workspace contains several interesting visual mini-games with their respecti
- Robo Collector - focused on learning ROS2 topics
- Robo Miner - focused on learning ROS2 services
- Robo Cleaner - focused on learning ROS2 actions
- UR Dev - focused on learning UR robotics movements through URScript
- UR Driver - forked repositories of Universal Robots Client Library and Universal Robots ROS2 driver

**Git submodules**
This repository has it's dependencies configured as git submodules.
Expand Down
56 changes: 54 additions & 2 deletions doc/hierarchy_diagram.plantuml
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
@startuml
package "static C++ libs" {
package "static C++ libs layer 1" {
[cmake_helpers]
[utils]
[resource_utils]
}

package "static C++ libs layer 2" {
[sdl_utils]
[manager_utils]
[game_engine]
}

package "static C++ libs layer 3" {
[ros2_game_engine]
}

Expand All @@ -18,6 +24,15 @@ package "auto-generated" {
[asset_information]
}

package "sdl_dynamic_libs" {
[SDL2]
[SDL2_image]
[SDL2_ttf]
[SDL2_mixer]
}

[SDL2_dynamic_libs]

[robo_common]

package "robo_collector" {
Expand All @@ -39,11 +54,25 @@ package "robo_cleaner" {
[robo_cleaner_interfaces]
}

package "ur_driver" {
[universal_robots_client_library]
[universal_robots_ros2_driver]
[ur_msgs]
[ur_dashboard_msgs]
}

package "ur_dev" {
[urscript_interface]
[urscript_common]
[urscript_bridge]
[ur_control_gui]
}

' START libs & tools
cmake_helpers -> utils
utils -> resource_utils
resource_utils --> sdl_utils
sdl_utils -> manager_utils
sdl_utils -d-> manager_utils
manager_utils -> game_engine
game_engine -> ros2_game_engine

Expand All @@ -52,6 +81,13 @@ resource_builder --> asset_information
resource_builder --> cpp_headers
asset_information --> game_engine
cpp_headers --> game_engine

SDL2 --> SDL2_dynamic_libs
SDL2_image --> SDL2_dynamic_libs
SDL2_ttf --> SDL2_dynamic_libs
SDL2_mixer --> SDL2_dynamic_libs

SDL2_dynamic_libs --> sdl_utils : private\ndependency
' END libs & tools

manager_utils --> robo_common
Expand Down Expand Up @@ -79,4 +115,20 @@ robo_cleaner_common --> robo_cleaner_gui
ros2_game_engine --> robo_cleaner_gui
' END Robo Cleaner

' START UR Driver
universal_robots_client_library --> universal_robots_ros2_driver
universal_robots_ros2_driver --> ur_msgs
universal_robots_ros2_driver --> ur_dashboard_msgs
' END UR Driver

' START UR Dev
urscript_interface --> urscript_common
urscript_common --> urscript_bridge
ur_msgs --> urscript_bridge
ros2_game_engine --> urscript_bridge
ros2_game_engine --> ur_control_gui
ur_dashboard_msgs --> ur_control_gui
urscript_common -u-> ur_control_gui
' END UR Dev

@enduml
Loading

0 comments on commit 7022de5

Please sign in to comment.