Skip to content

Commit

Permalink
Add a separate readme for the library
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanscherzinger committed Apr 20, 2024
1 parent 0b3b4b6 commit c31da39
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions schunk_egu_egk_gripper_library/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Schunk EGU/EGK Gripper Library

This is the C++ driver library for SCHUNK EGU/EGK grippers.
It implements the core functionality of the communication for usage in non-ROS2 C++ frameworks.

## Standalone build and usage

Get the `schunk_egu_egk_gripper` package following [these instructions](../README.md#build-and-install).
Navigate into the `schunk_egu_egk_gripper_library` sub package and call

```bash
mkdir build && cd "$_"
cmake ..
make
```
to build the library with plain *CMake*.
You can then include this library in the *CMakeLists.txt* of your application with the usual functionality:
```cmake
cmake_minimum_required(VERSION 3.22)
project(your_application)
# Find the library as a dependency
find_package(schunk_egu_egk_gripper_library REQUIRED)
# Link your application against the library
target_link_libraries(your_application
Schunk::schunk_egu_egk_gripper_library
)
```

0 comments on commit c31da39

Please sign in to comment.