Skip to content
Snippets Groups Projects
Commit 761e96a9 authored by Joan Solà Ortega's avatar Joan Solà Ortega
Browse files

Add documentation about the WOLF_DIR environment, in README.md

parent a65fc6c1
No related branches found
No related tags found
No related merge requests found
......@@ -164,6 +164,44 @@ Download and build
$ make
$ sudo make install //optional in case you want to install wolf library
**Set the WOLF environment**
We need a platform-independent way to specify where are our configuration files.
For example, if we want to use YAML files for configuring sensors, `YAML::LoadFile(filename)` needs an absolute path to a `filename`
__Solution:__
1. To run from __Terminal__, you need to create an environment variable WOLF_ROOT pointing to where the wolf project is
- Edit file ````~/.bashrc````, or ````~/.bash_profile````, and add these lines:
\code
# WOLF
export WOLF_ROOT="/abs/path/to/wolf"
\endcode
- Then you need to source the file to get effect,
\code
source ~/.bash_profile // or ~/.bashrc, of course
\endcode
2. If you run your application from __eclipse__, do:
- Menu Run > Run configurations...
- Add, or edit, a run configuration for the executable you want to run
- Click on tab 'Environment'
- Add a variable named ````WOLF_ROOT````, with value ````/abs/path/to/wolf````
3. If you run from __QtCreator__
- Click on Left bar > Projects > Tab 'Build'
- Under 'Build Environment', click 'Details'
- Add variable `WOLF_ROOT` with value `/abs/path/to/wolf`
- Click on Tab 'Run'
- Select your Run configuration
- Under 'Run Environment', make sure it says 'Use Build Environment'
- If not, click on 'Details'
- Under 'Base environment for this run configuration', select 'Build Environment'
### Wolf ROS Node
`$ git clone `[`https://github.com/IRI-MobileRobotics/Wolf_ros.git`](https://github.com/IRI-MobileRobotics/Wolf_ros.git)
......
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