Turtle Nest 项目使用教程

1. 项目目录结构及介绍

Turtle Nest 是一个用于创建 ROS 2 包的图形用户界面工具，其目录结构如下：

• .github/
  • workflows/：包含项目的自动化流程，如 CI/CD 配置。
• docker/：如果需要使用 Docker 容器，这个目录会包含相关的 Docker 配置文件。
• images/：存储项目相关的图片文件。
• turtle_nest/：项目的主要目录，包含源代码和资源文件。
  • src/：源代码目录。
  • include/：头文件目录。
  • lib/：库文件目录。
  • bin/：可执行文件目录。
  • CMakeLists.txt：CMake 构建配置文件。
  • package.xml：包的描述文件。
• turtle_nest_tests/：测试代码目录。
• .dockerignore：Docker 忽略文件，指定不被包含在 Docker 镜像中的文件。
• .gitignore：Git 忽略文件，指定不被包含在 Git 仓库中的文件。
• LICENSE：项目许可证文件，本项目采用 Apache-2.0 许可。
• README.md：项目说明文件。

2. 项目的启动文件介绍

Turtle Nest 的启动文件是 turtle_nest 目录下的 main.py 文件。这个文件负责初始化图形用户界面，并响应用户的操作来创建 ROS 2 包。

# main.py 示例代码
def main():
    # 初始化 GUI
    app = QApplication(sys.argv)
    window = MainWindow()
    window.show()
    sys.exit(app.exec_())

if __name__ == '__main__':
    main()

用户通过运行 main.py 文件启动图形界面，然后可以按照提示输入信息，创建新的 ROS 2 包。

3. 项目的配置文件介绍

项目的配置文件主要包括 CMakeLists.txt 和 package.xml。

• CMakeLists.txt：这是 CMake 的主配置文件，用于定义构建过程。它包含项目的名称、版本、依赖项和构建目标等。

# CMakeLists.txt 示例片段
project(turtle_nest
  VERSION 1.0.0
  DESCRIPTION "A tool for creating ROS 2 packages"
)

# 设置 C++ 标准和找到必需的包
set(CMAKE_CXX_STANDARD 11)
find_package(rclcpp REQUIRED)

# 添加执行文件
add_executable(turtle_nest src/main.cpp)

# 链接必需的库
target_link_libraries(turtle_nest rclcpp)

• package.xml：这是 ROS 包的描述文件，它定义了包的元数据，包括名称、版本、维护者信息和依赖关系。

<?xml version="1.0"?>
<package format="2">
  <name>turtle_nest</name>
  <version>1.0.0</version>
  <description>The turtle_nest package</description>
  <maintainer email="[e-mail]">Maintainer Name</maintainer>
  <license>Apache-2.0</license>
  <buildtool_depend>cmake</buildtool_depend>
  <exec_depend>rclcpp</exec_depend>
</package>

通过正确配置这些文件，可以确保 ROS 2 包能够正确构建和运行。