Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
paulbourelly999 committed Jul 31, 2024
1 parent 07c0f1e commit adb343c
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,15 @@ apt install carma-clock-1
```

This steps above add the relavent STOL apt repository for pulling correct debian package.
> [!IMPORTANT]\
>The python bindings for **CARMA Time Lib** are not included by default in the debian package. To install this library for use
with python we suggest you install it locally with the following steps

```shell
./install_dependencies.sh
cmake -Bbuild -DBUILD_PYTHON_BINDINGS=ON .
cmake --build build
```

### Including with CMake (C++)
To find and link this library via CMake the following commands are necessary
Expand All @@ -58,12 +67,12 @@ target_link_libraries( ${PROJECT_NAME} PUBLIC
### Importing as Python Module
> [!IMPORTANT]\
>Python module support is currently only available for x86/amd devices
To import this library as a python module the following is necessary
To import this library as a python module the following is necessary. A

```python
# This path can be added via the sys module or by directly appending the PYTHON_PATH environment variable.
import sys
sys.path.append('/opt/carma/lib/')
sys.path.append('/path/to/library')
# Import module
import libcarma_clock
...
Expand Down

0 comments on commit adb343c

Please sign in to comment.