From 0b5aa5003d0c26ead6ff2bd84764c71530fe94dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joan=20Sol=C3=A0=20Ortega?= <jsola@iri.upc.edu> Date: Wed, 15 May 2019 18:38:45 +0200 Subject: [PATCH] Update PluginsInfo.md --- PluginsInfo.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/PluginsInfo.md b/PluginsInfo.md index b217bc7b0..822109172 100644 --- a/PluginsInfo.md +++ b/PluginsInfo.md @@ -1,6 +1,9 @@ # Overview + # Installing + ## Installing wolf(core) + ``` git clone https://gitlab.iri.upc.edu/mobile_robotics/wolf_projects/wolf_lib/plugins/core.git cd core @@ -9,7 +12,9 @@ cmake .. make make install ``` + ## Installing plugins + ``` git clone https://gitlab.iri.upc.edu/mobile_robotics/wolf_projects/wolf_lib/plugins/<plugin name>.git cd <plugin name> @@ -20,13 +25,21 @@ make install ``` # 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 -`find_package(wolf REQUIRED)` +`find_package(wolf REQUIRED)`. + If wolf is indeed installed, this will define two variables `${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 -If you instead want to use some wolf plugin, you just follow the same procedure, changing the name -`find_package(wolf<plugin name> REQUIRED)` +and `${wolf_LIBRARY}` which will contain the path to the wolf library. + +## 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 `${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. @@ -40,6 +53,7 @@ cmake .. make sudo make install ``` + Then, in the CMakeLists.txt of the application we are developing we will put the following line ``` find_package(wolfvision REQUIRED) @@ -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. # Creating your plugin + We provide a template to create your own plugin. You can either clone it and restart the git history ``` -- GitLab