Skip to content

Commit 491e9c2

Browse files
author
Felix Exner
authored
Merge pull request #29 from fmauch/improve_documentation
Improve documentation
2 parents 04a004e + 6a69b1b commit 491e9c2

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,25 @@
2323

2424
<!--te-->
2525

26-
---
27-
<div style="background-color:red;color:black;padding:5pt;">DISCLAIMER: This library is still
28-
under development. Documentation may be missing and things might change in the near future.</div>
29-
30-
---
31-
3226
A C++ library for accessing Universal Robots interfaces. With this library C++-based drivers can be
3327
implemented in order to create external applications leveraging the versatility of Universal Robots
3428
robotic manipulators.
3529

30+
## Requirements
31+
* The library requires an implementation of **POSIX threads** such as the `pthread` library
32+
* The [master](https://github.com/UniversalRobots/Universal_Robots_Client_Library/tree/master)
33+
branch of this repository requires a C++17-compatible compiler. For building this library without
34+
a C++17-requirement, please use the
35+
[boost](https://github.com/UniversalRobots/Universal_Robots_Client_Library/tree/boost) branch
36+
instead that requires the boost library.
37+
For the C++17 features, please use those minimum compiler versions:
38+
39+
| Compiler | min. version |
40+
|-----------|--------------|
41+
| **GCC** | 7 |
42+
| **Clang** | 7 |
43+
44+
3645
## Build instructions
3746
### Plain cmake
3847
To build this library standalone so that you can build you own applications using this library,
@@ -253,7 +262,7 @@ string from this function. If no answer is received, a `UrException` is thrown.
253262
254263
Note: In order to make this more useful developers are expected to wrap this bare interface into
255264
something that checks the returned string for something that is expected. See the
256-
[DashboardClientROS](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/blob/master/ur_robot_driver/include/ur_robot_driver/ros/dashboard_client_ros.h) as an example.
265+
[DashboardClientROS](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/blob/master/ur_robot_driver/include/ur_robot_driver/dashboard_client_ros.h) as an example.
257266
258267
## A word on the primary / secondary interface
259268
Currently, this library doesn't support the primary interface very well, as the [Universal Robots
@@ -277,7 +286,7 @@ for details on how to set this up.
277286
The RTDE receive thread will be scheduled to real-time priority automatically, if applicable. If
278287
this doesn't work, an error is raised at startup. The main thread calling `getDataPackage` should be
279288
scheduled to real-time priority by the application. See the
280-
[ur_robot_driver](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/blob/master/ur_robot_driver/src/ros/hardware_interface_node.cpp)
289+
[ur_robot_driver](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/blob/master/ur_robot_driver/src/hardware_interface_node.cpp)
281290
as an example.
282291
283292
## Producer / Consumer architecture

0 commit comments

Comments
 (0)