diff --git a/docs/content/conventions/example_files/ros_msgs_package/CMakeLists.txt b/docs/content/conventions/example_files/ros_msgs_package/CMakeLists.txt index ef700fc..56b4fe5 100644 --- a/docs/content/conventions/example_files/ros_msgs_package/CMakeLists.txt +++ b/docs/content/conventions/example_files/ros_msgs_package/CMakeLists.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: Alliander N. V. +# +# SPDX-License-Identifier: Apache-2.0 + cmake_minimum_required(VERSION 3.5) project(ros_package) diff --git a/docs/content/conventions/example_files/ros_package/CMakeLists.txt b/docs/content/conventions/example_files/ros_package/CMakeLists.txt index 7cb9a11..4519bfc 100644 --- a/docs/content/conventions/example_files/ros_package/CMakeLists.txt +++ b/docs/content/conventions/example_files/ros_package/CMakeLists.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: Alliander N. V. +# +# SPDX-License-Identifier: Apache-2.0 + cmake_minimum_required(VERSION 3.5) project(ros_package) diff --git a/docs/content/conventions/example_files/ros_package/package.xml b/docs/content/conventions/example_files/ros_package/package.xml index 8d258a0..108dd54 100644 --- a/docs/content/conventions/example_files/ros_package/package.xml +++ b/docs/content/conventions/example_files/ros_package/package.xml @@ -1,5 +1,12 @@ + + + ros_package 0.1.0 diff --git a/docs/content/conventions/ros_package.md b/docs/content/conventions/ros_package.md index 985af00..d54e0f7 100644 --- a/docs/content/conventions/ros_package.md +++ b/docs/content/conventions/ros_package.md @@ -1,3 +1,9 @@ + + # ros_package conventions ## Folder Structure @@ -43,25 +49,25 @@ This CMakeLists.txt file shows the different parts required to build a ROS packa :linenos: ::: -**1-6**:\ +**5-10**:\ The file always starts with a version definition, the package name and the CMake dependencies when building C++ and/or python files. -**8-10**:\ +**12-14**:\ If the package depends on other packages, these are defined. In this case, the packaged depends on the *vision_msgs* and *geometry_msgs* packages. -**12-18**:\ +**16-22**:\ Building a C++ executable requires 3 steps: defining the executable, linking dependencies (if any) and installing the targets to the lib directory. -**20-24**:\ +**24-28**:\ For Python executables, we can simply install them all at the same time, by providing the directory. -**26-27**:\ +**30-31**:\ If the package contains a Python package, it needs to be installed. -**29-33**\ +**33-37**:\ All shared folders are installed into the share directory. This includes the directory of launch files, but also other possible directories, like `urdf/` or `config/`, if these exist. -**35-41**:\ +**39-45**:\ The file always ends with a default test and the *ament_package()* command. ## package.xml @@ -76,14 +82,14 @@ The package.xml file is related to the CMakeLists.txt file: **1-2**:\ The files starts with default xml definitions. -**3-8**:\ +**10-15**:\ Inside the *package* tag, we start with some general information about the package. -**10-11**:\ +**17-18**:\ Next, we define the build tool dependencies for building C++ and/or Python files. -**13-14**:\ +**20-21**:\ Next, we define other packages where our package depends on. -**16-21**"\ +**23-28**:\ The file ends with the default test dependency and an export definition. diff --git a/docs/content/conventions/ros_package_msgs.md b/docs/content/conventions/ros_package_msgs.md index 218c177..585112c 100644 --- a/docs/content/conventions/ros_package_msgs.md +++ b/docs/content/conventions/ros_package_msgs.md @@ -1,3 +1,9 @@ + + # ros_package_msgs conventions ## Folder Structure @@ -28,13 +34,13 @@ Also the CMakeLists.txt file is very similar. This shows an example where only c :linenos: ::: -**6**:\ +**10**:\ The *rosidl_default_generators* dependency is now required, to generated the custom messages. -**13-18**:\ +**16-22**:\ We use CMake's *GLOB* method to automatically obtain all the srv files. -**20-23**:\ +**24-27**:\ We generate the custom service and link the dependencies (if any). ## package.xml