diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..4415fabba3a3298ca4364114acf9842e5fbf9677 --- /dev/null +++ b/README.en.md @@ -0,0 +1,92 @@ +# Fast DDS Repository Build Scripts + +This repository contains a collection of scripts for building and configuring Fast DDS (Fast Data Distribution Service). Fast DDS is a high-performance implementation of DDS (Data Distribution Service), widely used in robotic systems and real-time distributed systems. + +## Project Structure + +### Script Descriptions + +#### `colcon-build.sh` +A script for building Fast DDS using colcon. Colcon is the build tool for ROS 2, supporting multiple build types and testing options. + +#### `fastdds.repos` +Fast DDS repository configuration file specifying the code repositories and their versions to be cloned and built. + +#### `install-dependencies.sh` +Dependency installation script responsible for installing system packages required to build Fast DDS. Supports execution with SUDO privileges. + +#### `replace-apt-source.sh` +APT source replacement script for configuring system software repositories. Includes configurations related to `field_index` and `u24_sources`, potentially for optimizing software sources on Ubuntu 24.04 (U24) systems. + +## Quick Start + +### Prerequisites +- Ubuntu 24.04 or a compatible Linux distribution +- ROS 2 build tool (colcon) +- Git +- CMake +- Python 3 + +### Installation Steps + +1. **Clone the Repository** +```bash +git clone https://gitee.com/codepee/fastdds-repo.git +cd fastdds-repo +``` + +2. **Install System Dependencies** +```bash +chmod +x install-dependencies.sh +./install-dependencies.sh +``` + +3. **Configure APT Source (if needed)** +```bash +chmod +x replace-apt-source.sh +./replace-apt-source.sh +``` + +4. **Initialize the Workspace** +```bash +mkdir -p ~/fastdds_ws/src +vcs import ~/fastdds_ws/src < fastdds.repos +``` + +5. **Build the Project** +```bash +chmod +x colcon-build.sh +./colcon-build.sh +``` + +## Key Features + +- **Automated Build**: Automates the compilation process of Fast DDS using colcon +- **Dependency Management**: Automatically installs all necessary build dependencies +- **Source Configuration Optimization**: Provides options to optimize APT source configurations +- **Repository Version Management**: Manages dependency repository versions via the `.repos` file + +## Frequently Asked Questions + +### Build Failure +If you encounter issues during the build process, check: +1. Whether all system dependencies are fully installed +2. Whether Git configuration is correct +3. Whether sufficient disk space is available + +### Permission Issues +Ensure scripts are executed with appropriate permissions; use `sudo` if necessary. + +## License + +This project follows the applicable open-source license agreement. + +## Contribution Guidelines + +Contributions via Issues or Pull Requests are welcome. + +## References + +- [Fast DDS Official Documentation](https://fast-dds.docs.eprosima.com/) +- [ROS 2 Documentation](https://docs.ros.org/) +- [eProsima Website](https://www.eprosima.com/) \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f0753ee6a5cb631520d39f963396c97dc3610318 --- /dev/null +++ b/README.md @@ -0,0 +1,94 @@ + + +# Fast DDS 仓库构建脚本 + +本仓库包含用于构建和配置 Fast DDS(Fast Data Distribution Service)的脚本集合。Fast DDS 是一个高性能的 DDS(Data Distribution Service)实现,广泛应用于机器人系统和实时分布式系统。 + +## 项目结构 + +### 脚本说明 + +#### `colcon-build.sh` +用于使用 colcon 构建 Fast DDS 的脚本。Colcon 是 ROS 2 的构建工具,支持多种构建类型和测试选项。 + +#### `fastdds.repos` +Fast DDS 仓库配置文件,用于指定需要克隆和构建的代码仓库及其版本。 + +#### `install-depencies.sh` +依赖安装脚本,负责安装 Fast DDS 构建所需的系统依赖包。支持使用 SUDO 权限运行。 + +#### `replace-apt-source.sh` +APT 源替换脚本,用于配置系统软件源。包含 `field_index` 和 `u24_sources` 相关配置,可能用于 Ubuntu 24.04 (U24) 系统的软件源优化。 + +## 快速开始 + +### 环境要求 +- Ubuntu 24.04 或兼容的 Linux 发行版 +- ROS 2 构建工具(colcon) +- Git +- CMake +- Python 3 + +### 安装步骤 + +1. **克隆仓库** +```bash +git clone https://gitee.com/codepee/fastdds-repo.git +cd fastdds-repo +``` + +2. **安装系统依赖** +```bash +chmod +x install-depencies.sh +./install-depencies.sh +``` + +3. **配置 APT 源(如需要)** +```bash +chmod +x replace-apt-source.sh +./replace-apt-source.sh +``` + +4. **初始化工作空间** +```bash +mkdir -p ~/fastdds_ws/src +vcs import ~/fastdds_ws/src < fastdds.repos +``` + +5. **构建项目** +```bash +chmod +x colcon-build.sh +./colcon-build.sh +``` + +## 主要功能 + +- **自动化构建**: 使用 colcon 自动化 Fast DDS 的编译过程 +- **依赖管理**: 自动安装所有必要的构建依赖 +- **源配置优化**: 提供 APT 源配置优化选项 +- **仓库版本管理**: 通过 `.repos` 文件管理依赖仓库版本 + +## 常见问题 + +### 构建失败 +如果构建过程中遇到问题,请检查: +1. 系统依赖是否完整安装 +2. Git 配置是否正确 +3. 磁盘空间是否充足 + +### 权限问题 +确保以适当权限运行脚本,必要时使用 `sudo`。 + +## 许可证 + +本项目遵循相应的开源许可证协议。 + +## 贡献指南 + +欢迎通过 Issue 或 Pull Request 贡献代码。 + +## 参考资料 + +- [Fast DDS 官方文档](https://fast-dds.docs.eprosima.com/) +- [ROS 2 文档](https://docs.ros.org/) +- [eProsima 官网](https://www.eprosima.com/) \ No newline at end of file