Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
gibernas committed Dec 27, 2018
1 parent e07e4b9 commit 8471cbe
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![CircleCI](https://circleci.com/gh/duckietown/duckietown-visualodo.svg?style=shield)](https://circleci.com/gh/duckietown/duckietown-visualodo)

[![Coverage Status](https://coveralls.io/repos/github/duckietown/duckietown-visualodo/badge.svg?branch=master18)](https://coveralls.io/github/duckietown/duckietown-visualodo?branch=master18)
[![Coverage Status](https://coveralls.io/repos/github/duckietown/duckietown-visualodo/badge.svg?branch=master18)](https://coveralls.io/github/duckietown/duckietown-visualodo?branch=master)

[![PyPI status](https://img.shields.io/pypi/status/duckietown_visualodo.svg)](https://pypi.python.org/pypi/duckietown_visualodo/)

Expand All @@ -15,20 +15,24 @@ A pipeline for monocular visual odometry

## Installation from source

This is the way to install within a virtual environment created by
This is the way to install within a virtual environment created by
using `pipenv`:

$ pipenv install
$ pipenv shell
$ cd lib-visualodo
$ pip install -r requirements.txt
$ python setup.py develop --no-deps


## Unit tests

Run this:

$ make -C lib-visualodo tests-clean tests

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

## 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)

0 comments on commit 8471cbe

Please sign in to comment.