Skip to content
Snippets Groups Projects
Commit 87381d7b authored by Joan Solà Ortega's avatar Joan Solà Ortega Committed by Joan Solà Ortega
Browse files

Update ReadMe.md

parent b37a81f0
No related branches found
No related tags found
1 merge request!218Wolf script readme update
...@@ -8,7 +8,9 @@ Helpful scripts to create WOLF tree elements (e.g. processors) ...@@ -8,7 +8,9 @@ Helpful scripts to create WOLF tree elements (e.g. processors)
* __RealPath__ (Required): Install with the following command. * __RealPath__ (Required): Install with the following command.
..*`sudo apt-get install realpath` ```
sudo apt-get install realpath
```
* __RealPath__ (Required, MacOSX): The realpath package above is not available for MacOSX. * __RealPath__ (Required, MacOSX): The realpath package above is not available for MacOSX.
Here is an out-of-the-box alternative Here is an out-of-the-box alternative
...@@ -17,9 +19,9 @@ Helpful scripts to create WOLF tree elements (e.g. processors) ...@@ -17,9 +19,9 @@ Helpful scripts to create WOLF tree elements (e.g. processors)
- Create a small project `realpath` (here in `$HOME/dev/` as an example) - Create a small project `realpath` (here in `$HOME/dev/` as an example)
``` ```
$ cd $HOME/dev cd $HOME/dev
$ mkdir realpath mkdir realpath
$ cd realpath cd realpath
``` ```
- Create a file `realpath.c` with the contents: - Create a file `realpath.c` with the contents:
...@@ -64,24 +66,28 @@ Helpful scripts to create WOLF tree elements (e.g. processors) ...@@ -64,24 +66,28 @@ Helpful scripts to create WOLF tree elements (e.g. processors)
- Then compile with `make`: - Then compile with `make`:
``` ```
$ make make
``` ```
- and put in a soft link with: - and put in a soft link with:
``` ```
$ ln -s $(pwd)/realpath /usr/local/bin/realpath ln -s $(pwd)/realpath /usr/local/bin/realpath
``` ```
#### SCRIPTS installation #### SCRIPTS installation
* Move to the scripts folder * Move to the scripts folder
..*`cd $WOLF_ROOT/wolf_scripts` ```
cd $WOLF_ROOT/wolf_scripts
```
* Run the following line to set your `bashrc`. This will allow you to execute the scripts from any console path. * Run the following line to set your `bashrc`. This will allow you to execute the scripts from any console path.
..*`echo "source $WOLF_ROOT/wolf_scripts/setup.bash" >> ~/.bashrc` ```
echo "source $WOLF_ROOT/wolf_scripts/setup.bash" >> ~/.bashrc
```
## Usage ## Usage
...@@ -90,7 +96,19 @@ Helpful scripts to create WOLF tree elements (e.g. processors) ...@@ -90,7 +96,19 @@ Helpful scripts to create WOLF tree elements (e.g. processors)
Creates the main structure including .cpp and .h files, and a gtest for the new derived class (all in corresponding folders of WOLF directory. Creates the main structure including .cpp and .h files, and a gtest for the new derived class (all in corresponding folders of WOLF directory.
* Example of usage * Example of usage
`create_wolf_processor.sh -t processor -n example -b tracker` ```
wolf_create.sh -t processor -n example -b tracker
```
will create a new class `ProcessorTrackerExample`, with files:
```
src/processors/processor_tracker_example.h
src/processors/processor_tracker_example.cpp
src/test/gtest_processor_tracker_example.cpp
```
and modify the `CMakeLists.txt` files in the directories `src/processors/` and `src/test/`.
* Options: * Options:
- t: Type. Any of the following [ capture | constraint | feature | processor | sensor ]" - t: Type. Any of the following [ capture | constraint | feature | processor | sensor ]"
......
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