This repository provides a simple way to create a fully functional C++ project using the CMake tool. It allows to create to different kind of projetcs:
This repository provides a simple way to create a fully functional C++ project using the CMake tool. It allows to create two different kind of projetcs:
***library**: the final result is a shared library that can be used by other libraries or applications. It also includes a simple executable to demonstrate the use of the generated library.
***library**: the final result is a shared library that can be used by other libraries or applications. It also includes a simple executable to demonstrate the use of the generated library.
***application**: the final result is an executable.
***application**: the final result is an executable application.
The script allows to select the name of the desired library or executable, together with a brief description and a list of other system or IRI dependencies. Additionally, it also provides an option to include a basic test framework using the [googletest](https://github.com/google/googletest GoogleTest github page) software.
The script allows to select the name of the desired library or executable, together with a brief description and a list of other system or IRI dependencies. Additionally, it also provides an option to include a basic test framework using the [googletest](https://github.com/google/googletest GoogleTest github page) software.
...
@@ -21,12 +21,12 @@ Clone the repository to the desired location.
...
@@ -21,12 +21,12 @@ Clone the repository to the desired location.
Execute the *new_project.sh* script with the following parameters:
Execute the *new_project.sh* script with the following parameters:
***-t project\_type**: this parameter is required. It specifies which kind of project is to be created. At the moment, only two project types types are allowed:
***-t project\_type**: this parameter is required. It specifies which kind of project is to be created. At the moment, only two project types are allowed:
**library*: generates the necessary structure to create a shared library that can be used in other driver or applications.
**library*: generates the necessary structure to create a shared library that can be used by other libraries or applications.
**application*: generates the necessary structure to create a binary file.
**application*: generates the necessary structure to create an execuable binary file.
***-p "the project description"**: this parameter is required. It provides a short description of the project. This parameter will appear in all the associated documentation. For multi-word values, use the double quote.
***-p "the project description"**: this parameter is required. It provides a short description of the project. This parameter will appear in all the associated documentation. For multi-word values, use the double quote.
***-n project\_name**: this parameter is required. It specifies the name of the shared library or the binary file to be generate by the project. **This parameter must not have any whitespace characters**.
***-n project\_name**: this parameter is required. It specifies the name of the shared library or the binary file. **This parameter must not have any whitespace characters**.
***-d comma,separated,dependencies**: this parameter is optional. It specifies a set of dependencies of the library or application being generated. These depedencies will be automatically included inside the CMake structure. Only dependencies developed at IRI are currently supported. Other type of dependencies should better be added by hand.
***-d comma,separated,dependencies**: this parameter is optional. It specifies a set of dependencies of the library or application. These depedencies will be automatically included inside the CMake structure. Only dependencies developed at IRI are currently supported. Other type of dependencies should better be added by hand once the project has been already created.
[//]:<>(Commented test option until it is operative again)
[//]:<>(Commented test option until it is operative again)
[//]:<>(* **-g**: this parameters is optional. Is specifies whether the test strcture is to be included into the project or not. This includes the necessaty CMake files to download and locally build the google test software and a basic test file for the generated project.)
[//]:<>(* **-g**: this parameters is optional. Is specifies whether the test strcture is to be included into the project or not. This includes the necessaty CMake files to download and locally build the google test software and a basic test file for the generated project.)
