From 53db25f8f0f5190270280cfec048d44cac923bd8 Mon Sep 17 00:00:00 2001 From: Silvio Traversaro Date: Wed, 27 Nov 2024 13:51:21 +0100 Subject: [PATCH] Add basic README.md --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 65e0e0d..cf4f3e8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ -![YARP logo](doc/images/yarp-robot-24.png?raw=true "YARP") -YARP-ros -==== +## yarp-ros -This repo is currently under construction. Please do not use it! +> [!WARNING] +> The functionality that provide compatibility between YARP and ROS 1 are deprecated and will be removed in YARP 3.11 . Please migrate to use https://github.com/robotology/yarp-devices-ros2 instead. +> This repository permit to continue to use ROS 1 with YARP 3.10, but will not work with YARP 3.11 . + +This repository contains the following functionality that used to be part of the main YARP repository, and were moved in this repo in YARP 3.10: +* The carriers `tcpros` and `xmlrpc`, used for ROS 1 compatibility at port protocol level, +* the `rosmsg` YARP IDL code generator, used to generate YARP serializable classes out of ROS's `.msg` definitions. + +This is quite a standard CMake repository that can be installed using the usual CMake process for installing packages.