From b18631ebfc745d546594e00f45c1dbc7f8eeee7b Mon Sep 17 00:00:00 2001 From: Alejandro Lopez Gestoso <alopez@iri.upc.edu> Date: Thu, 21 Feb 2019 16:30:21 +0100 Subject: [PATCH] Some minor changes on ReadMe.md --- ReadMe.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ReadMe.md b/ReadMe.md index 17e39d6..b82d386 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -21,17 +21,17 @@ Clone the repository to the desired location. 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 types are allowed: * *library*: generates the necessary structure to create a shared library that can be used in other driver or applications. * *application*: generates the necessary structure to create a binary file. -* **-p <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 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 to be generate by the project. **This parameter must not have any whitespace characters**. -* **-i <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 supported by the CMake framework are currently supported. +* **-i 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 supported by the CMake framework are currently supported. -* ** -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. After executing the script, all the temporary and template files are removed, as well as the link to the remote GIT repository, so that the new project can be easily associated to another repository. -- GitLab