Skip to content

Commit

Permalink
update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gibernas committed Dec 27, 2018
1 parent 545a719 commit 0ef699f
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,20 @@ using `pipenv`:

## Unit tests

Run this:
To perform the unit tests present run:

$ make -C lib-visualodo tests-clean tests

The output is generated in the folder in `lib-visualodo/out-comptests/`.

## Visualization of the results

In case you want to enable the plotting features (i.e. image containing the used mask, the feature extraction and matching or the outlier filtering), set the relevant variable to `True` in `lib-visualodo/src/duckietown-visualodo/data/default.yaml`

## Documentation

Detailed documentation for running the demo and on the implementation of the visual odometry pipeline can be found on the [Duckiebook](http://docs.duckietown.org/DT18/opmanual_duckiebot/out/demo_visualodometry.html)

## Code structure

The package is structured the following way: in `ros-visualodo`, the code responsible for the node instantiation and the communication with other nodes is placed. In `lib-visualodo`, all the actual logic is implemented, the parameters are contained and the unit tests are present.

0 comments on commit 0ef699f

Please sign in to comment.