From 63ae21fb4e53bc80d0cb87911892cc8caa6c9fdd Mon Sep 17 00:00:00 2001
From: Alejandro Lopez Gestoso <alopez@iri.upc.edu>
Date: Tue, 9 Jul 2019 11:03:34 +0200
Subject: [PATCH] Update ReadMe.md
---
ReadMe.md | 58 +++++++++++++++++++++++++++++++++++++++----------------
1 file changed, 41 insertions(+), 17 deletions(-)
diff --git a/ReadMe.md b/ReadMe.md
index 06f8ce4..e8cbd42 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -68,9 +68,36 @@ time in human readable format.
There exist an example which uses all of class methods. Also in a bad use
which reach to an exception.
-## Dependencies
+## Installation
+
+* Add the labrobotica repository if it is not already added:
+
+``` sudo sh -c 'echo "deb [arch=amd64] http://147.83.76.226/~irilabo/packages xenial main" > /etc/apt/sources.list.d/labrobotica_repo.list' ```
+
+``` wget -O - http://147.83.76.226/~irilabo/labrobotica_repo.gpg.key | sudo apt-key add - ```
+
+* Install the package:
+
+``` sudo apt update && sudo apt install iri-dynamixel-pan-tilt-dev ```
+
+## Disclaimer
+
+Copyright (C) 2009-2018 Institut de Robòtica i Informà tica Industrial, CSIC-UPC.
+Mantainer IRI labrobotics (labrobotica@iri.upc.edu)
+
+This package is distributed in the hope that it will be useful, but without any warranty. It is provided "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the program is with you. should the program prove defective, the GMR group does not assume the cost of any necessary servicing, repair or correction.
+
+In no event unless required by applicable law the author will be liable to you for damages, including any general, special, incidental or consequential damages arising out of the use or inability to use the program (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the program to operate with any other programs), even if the author has been advised of the possibility of such damages.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>
+
+## For developers
+
+<details><summary>click here</summary>
+<p>
-**DELETE ME** List all the system dependencies first, for example:
+## Dependencies
This package requires of the following system libraries and packages
@@ -82,12 +109,6 @@ Under linux all of these utilities are available in ready-to-use packages.
Under MacOS most of the packages are available via [fink](http://www.finkproject.org/ "Fink's Homepage")
-**DELETE ME** List the IRI dependencies next, for example:
-
-This package also requires of the following IRI libraries:
-
-* [iriutils](https://gitlab.iri.upc.edu/labrobotica/algorithms/iriutils "iriutils gitlab page"), a set of basic tools.
-
## Compilation and installation
Download this repository and create a build folder inside:
@@ -105,7 +126,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.
@@ -143,15 +164,18 @@ and it is also necessary to link with the desired libraries by using the followi
``` TARGET_LINK_LIBRARIES(<executable name> ${iriutils_LIBRARY}) ```
-## Disclaimer
-
-Copyright (C) 2009-2018 Institut de Robòtica i Informà tica Industrial, CSIC-UPC.
-Mantainer IRI labrobotics (labrobotica@iri.upc.edu)
+## Examples
-This package is distributed in the hope that it will be useful, but without any warranty. It is provided "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the program is with you. should the program prove defective, the GMR group does not assume the cost of any necessary servicing, repair or correction.
+There are some examples:
+ * _test\_both_: An example of how two threads communicate through events.
+ * _test\_events_: It shows the basic operation with events and the most important feature, which is the wait() function.
+ * _test\_eventserver_: It shows how to handle multiple events using the CEventServer class.
+ * _test\_logs_: It shows the differents log options provided by the class which include logging.
+ * _test\_threads_: It shows how to use the CThread class.
+ * _test\_threadserver_: It shows how to handle multiple threads using the CThreadServer class.
+ * _test\_time_: It checks all functions in CTime class.
-In no event unless required by applicable law the author will be liable to you for damages, including any general, special, incidental or consequential damages arising out of the use or inability to use the program (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the program to operate with any other programs), even if the author has been advised of the possibility of such damages.
-You should have received a copy of the GNU Lesser General Public License
-along with this program. If not, see <http://www.gnu.org/licenses/>
+</p>
+</details>
--
GitLab