Skip to content
Snippets Groups Projects
Commit 4b02035f authored by Alejandro Lopez Gestoso's avatar Alejandro Lopez Gestoso
Browse files

Update ReadMe.md

parent f9996899
No related branches found
No related tags found
No related merge requests found
......@@ -57,6 +57,7 @@ This package requires of the following system libraries and packages
* [cmake](https://www.cmake.org "CMake's Homepage"), a cross-platform build system.
* [doxygen](http://www.doxygen.org "Doxygen's Homepage") and [graphviz](http://www.graphviz.org "Graphviz's Homepage") to generate the documentation.
* [XSD](http://wiki.codesynthesis.com/XSD "XSD wiki main page") to enable XML support.
* stdc++.
Under linux all of these utilities are available in ready-to-use packages.
......@@ -86,7 +87,7 @@ The RELEASE build mode optimizes for speed. To build in this mode execute instea
The release mode will be kept until next time cmake is executed.
``` make ```
``` make -j $(nproc)```
In case no errors are reported, the generated libraries (if any) will be located at the
_lib_ folder and the executables (if any) will be located at the _bin_ folder.
......@@ -97,8 +98,9 @@ To do that, execute
``` make install ```
as root and the shared libraries will be copied to */usr/local/lib/iri/ptu_d46* directory
and the header files will be copied to */usr/local/include/iri/ptu_d46* dierctory. At
this point, the library may be used by any user.
and the header files will be copied to */usr/local/include/iri/ptu_d46* dierctory. If the
support for XML file is enabled, all the necessary files will be copied to */usr/local/include/iri/ptu_d46/xml*.
At this point, the library may be used by any user.
To remove the library from the system, exceute
......@@ -114,15 +116,22 @@ To generate the documentation execute the following command:
To use this library in an other library or application, in the CMakeLists.txt file, first it is necessary to locate if the library has been installed or not using the following command
``` FIND_PACKAGE(<library name>) ```
``` FIND_PACKAGE(ptu_d46) ```
In the case that the package is present, it is necessary to add the header files directory to the include directory path by using
``` INCLUDE_DIRECTORIES(${<librray name>_INCLUDE_DIRS}) ```
``` INCLUDE_DIRECTORIES($ptu_d46_INCLUDE_DIRS}) ```
and it is also necessary to link with the desired libraries by using the following command
``` TARGET_LINK_LIBRARIES(<executable name> ${<library name>_LIBRARIES}) ```
``` TARGET_LINK_LIBRARIES(<executable name> ${ptu_d46_LIBRARIES}) ```
## Examples
There are three examples:
* _test\_ptu\_d46_ where the pan&tilt unit is moved to an absolute angle.
* _test\_ptu\_d46\_speed where the pan&tilt unit is moved on torque mode.
* _test\_sequence_ where the pan%tilt unit is moved following a trajectory.
</p>
</details>
......
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