Skip to content
Snippets Groups Projects
Commit 0b5aa500 authored by Joan Solà Ortega's avatar Joan Solà Ortega
Browse files

Update PluginsInfo.md

parent 2c040bf1
No related branches found
No related tags found
No related merge requests found
# Overview # Overview
# Installing # Installing
## Installing wolf(core) ## Installing wolf(core)
``` ```
git clone https://gitlab.iri.upc.edu/mobile_robotics/wolf_projects/wolf_lib/plugins/core.git git clone https://gitlab.iri.upc.edu/mobile_robotics/wolf_projects/wolf_lib/plugins/core.git
cd core cd core
...@@ -9,7 +12,9 @@ cmake .. ...@@ -9,7 +12,9 @@ cmake ..
make make
make install make install
``` ```
## Installing plugins ## Installing plugins
``` ```
git clone https://gitlab.iri.upc.edu/mobile_robotics/wolf_projects/wolf_lib/plugins/<plugin name>.git git clone https://gitlab.iri.upc.edu/mobile_robotics/wolf_projects/wolf_lib/plugins/<plugin name>.git
cd <plugin name> cd <plugin name>
...@@ -20,13 +25,21 @@ make install ...@@ -20,13 +25,21 @@ make install
``` ```
# Using wolf in your applications # Using wolf in your applications
## Using wolf core
If you want to use the core, you just need to have it installed and in your CMakeLists.txt put the following line If you want to use the core, you just need to have it installed and in your CMakeLists.txt put the following line
`find_package(wolf REQUIRED)` `find_package(wolf REQUIRED)`.
If wolf is indeed installed, this will define two variables If wolf is indeed installed, this will define two variables
`${wolf_INCLUDE_DIR}` which will contain the path to the wolf include directory `${wolf_INCLUDE_DIR}` which will contain the path to the wolf include directory
and `${wolf_LIBRARY}` which will contain the path to the wolf library and `${wolf_LIBRARY}` which will contain the path to the wolf library.
If you instead want to use some wolf plugin, you just follow the same procedure, changing the name
`find_package(wolf<plugin name> REQUIRED)` ## Using wolf plugins
If you also want to use some wolf plugin, you just follow the same procedure, changing the name
`find_package(wolf<plugin name> REQUIRED)`.
If the pluging is indeed installed, this will define two variables If the pluging is indeed installed, this will define two variables
`${wolf<plugin name>_INCLUDE_DIR}` which will contain the path to the plugin's include directory `${wolf<plugin name>_INCLUDE_DIR}` which will contain the path to the plugin's include directory
and `${wolf<plugin name>_LIBRARY}` which will contain the path to the plugin's library. and `${wolf<plugin name>_LIBRARY}` which will contain the path to the plugin's library.
...@@ -40,6 +53,7 @@ cmake .. ...@@ -40,6 +53,7 @@ cmake ..
make make
sudo make install sudo make install
``` ```
Then, in the CMakeLists.txt of the application we are developing we will put the following line Then, in the CMakeLists.txt of the application we are developing we will put the following line
``` ```
find_package(wolfvision REQUIRED) find_package(wolfvision REQUIRED)
...@@ -53,6 +67,7 @@ if the plugin has been correctly installed, and thus find_package succeeds, then ...@@ -53,6 +67,7 @@ if the plugin has been correctly installed, and thus find_package succeeds, then
the _core_ plugin, will not find its own dependencies. It is the responsibility of the programmer to do `find_package(wolf REQUIRED)` to get the includes and library. In the future this will change and each plugin will be responsible for finding all the necessary dependencies. the _core_ plugin, will not find its own dependencies. It is the responsibility of the programmer to do `find_package(wolf REQUIRED)` to get the includes and library. In the future this will change and each plugin will be responsible for finding all the necessary dependencies.
# Creating your plugin # Creating your plugin
We provide a template to create your own plugin. We provide a template to create your own plugin.
You can either clone it and restart the git history You can either clone it and restart the git history
``` ```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment