diff --git a/wolf_scripts/ReadMe.md b/wolf_scripts/ReadMe.md index d7d2c37c53cc0a9883d58a283f3a5c6e8c22ffbe..fd98c4e85bdbf4cd63e0fa91b05a2576545b779f 100644 --- a/wolf_scripts/ReadMe.md +++ b/wolf_scripts/ReadMe.md @@ -8,7 +8,9 @@ Helpful scripts to create WOLF tree elements (e.g. processors) * __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. Here is an out-of-the-box alternative @@ -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) ``` - $ cd $HOME/dev - $ mkdir realpath - $ cd realpath + cd $HOME/dev + mkdir realpath + cd realpath ``` - Create a file `realpath.c` with the contents: @@ -64,24 +66,28 @@ Helpful scripts to create WOLF tree elements (e.g. processors) - Then compile with `make`: ``` - $ make + make ``` - 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 * 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. - ..*`echo "source $WOLF_ROOT/wolf_scripts/setup.bash" >> ~/.bashrc` + ``` + echo "source $WOLF_ROOT/wolf_scripts/setup.bash" >> ~/.bashrc + ``` ## Usage @@ -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. * 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: - t: Type. Any of the following [ capture | constraint | feature | processor | sensor ]"