diff --git a/ReadMe_template.md b/ReadMe_template.md index f745621462eb78ab001c010ee31821a70ed4d1f9..72e5872d63168b4d174a6d9c9c3492a33ffe0038 100755 --- a/ReadMe_template.md +++ b/ReadMe_template.md @@ -5,6 +5,33 @@ project_name {#mainpage} project_description +## Installation + +* Add the labrobotica repository if it is not already added: + +Run the commands on _add repository_ and _add key_ from [labrobotica_how_to installation](https://gitlab.iri.upc.edu/labrobotica/labrobotica_how_to/-/blob/master/README.md#installation) + +* Install the package: + +``` sudo apt update && sudo apt install iri-project-name-dev ``` + +## Disclaimer + +Copyright (C) Institut de Robòtica i Informà tica Industrial, CSIC-UPC. +Mantainer author_name (author_email) + +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> + ## Dependencies This package requires of the following system libraries and packages @@ -17,11 +44,11 @@ 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") -This package also requires of the following IRI libraries: +This package also requires of the following dependencies: -## Compilation and installation +## Compilation and installation from source -Download this repository and create a build folder inside: +Clone this repository and create a build folder inside: ``` mkdir build ``` @@ -36,7 +63,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. @@ -46,8 +73,8 @@ To do that, execute ``` make install ``` -as root and the shared libraries will be copied to */usr/local/lib/iridrivers* directory -and the header files will be copied to */usr/local/include/iridrivers* dierctory. At +as root and the shared libraries will be copied to */usr/local/lib/iri/project_name* directory +and the header files will be copied to */usr/local/include/iri/project_name* directory. At this point, the library may be used by any user. To remove the library from the system, exceute @@ -62,7 +89,7 @@ To generate the documentation execute the following command: ## How to use it -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 +To use this library in another 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(project_name) ``` @@ -74,15 +101,9 @@ and it is also necessary to link with the desired libraries by using the followi ``` TARGET_LINK_LIBRARIES(<executable name> ${project_name_LIBRARIES}) ``` -## Disclaimer - -Copyright (C) 2009-2018 Institut de Robòtica i Informà tica Industrial, CSIC-UPC. -Mantainer author_name (author_email) +## 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. - -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/> +There are examples that show how to use the different classes. +</p> +</details> \ No newline at end of file