Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
Update documentation links to point to locally generated docs on Github pages.
  • Loading branch information
quantumxt authored May 6, 2024
1 parent bfee1e1 commit d88bae9
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<p align="center">
<img src="https://raw.githubusercontent.com/xdspacelab/openvslam/master/docs/img/logo.png" width="435px">
<img src="https://raw.githubusercontent.com/quantumxt/openvslam/master/docs/img/logo.png" width="435px">
</p>

# OpenVSLAM: A Versatile Visual SLAM Framework
[![Wercker Status](https://app.wercker.com/status/8b02a43f48216385658bb3857aae5fd8/s/master)](https://app.wercker.com/shinsumicco/openvslam/runs)
[![Travis CI Status](https://api.travis-ci.org/xdspacelab/openvslam.svg?branch=master)](https://travis-ci.org/xdspacelab/openvslam)
[![Documentation Status](https://readthedocs.org/projects/openvslam/badge/?version=master)](https://openvslam.readthedocs.io/)
[![documentation](https://github.com/quantumxt/openvslam/actions/workflows/docs.yml/badge.svg)](https://github.com/quantumxt/openvslam/actions/workflows/docs.yml)
[![Docker Build Status](https://img.shields.io/docker/cloud/build/shinsumicco/openvslam.svg)](https://hub.docker.com/r/shinsumicco/openvslam)
[![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)

## Overview

[<img src="https://raw.githubusercontent.com/xdspacelab/openvslam/master/docs/img/teaser.png" width="640px">](https://arxiv.org/abs/1910.01122)
[<img src="https://raw.githubusercontent.com/quantumxt/openvslam/master/docs/img/teaser.png" width="640px">](https://arxiv.org/abs/1910.01122)

[<img src="https://raw.githubusercontent.com/wiki/xdspacelab/openvslam/media/tracking.gif" width="640px">](https://www.youtube.com/watch?v=Ro_s3Lbx5ms)

Expand All @@ -32,9 +32,9 @@ For example, visual SLAM algorithm using **equirectangular camera models** (e.g.

Some code snippets to understand the core functionalities of the system are provided.
You can employ these snippets for in your own programs.
Please see the `*.cc` files in `./example` directory or check [Simple Tutorial](https://openvslam.readthedocs.io/en/master/simple_tutorial.html) and [Example](https://openvslam.readthedocs.io/en/master/example.html).
Please see the `*.cc` files in `./example` directory or check [Simple Tutorial](https://quantumxt.github.io/openvslam/simple_tutorial.html) and [Example](https://quantumxt.github.io/openvslam/example.html).

We provided [documentation](https://openvslam.readthedocs.io/) for installation and tutorial.
We provided [documentation](https://quantumxt.github.io/openvslam/) for installation and tutorial.
Please contact us via [GitHub issues](https://github.com/xdspacelab/openvslam/issues) if you have any questions or notice any bugs about the software.

## Motivation
Expand All @@ -45,18 +45,18 @@ In return, we hope this project will bring safe and reliable technologies for a

## Installation

Please see [**Installation**](https://openvslam.readthedocs.io/en/master/installation.html) chapter in the [documentation](https://openvslam.readthedocs.io/).
Please see [**Installation**](https://quantumxt.github.io/openvslam/installation.html) chapter in the [documentation](https://quantumxt.github.io/openvslam/).

[**The instructions for Docker users**](https://openvslam.readthedocs.io/en/master/docker.html) are also provided.
[**The instructions for Docker users**](https://quantumxt.github.io/openvslam/docker.html) are also provided.

## Tutorial

Please see [**Simple Tutorial**](https://openvslam.readthedocs.io/en/master/simple_tutorial.html) chapter in the [documentation](https://openvslam.readthedocs.io/).
Please see [**Simple Tutorial**](https://quantumxt.github.io/openvslam/simple_tutorial.html) chapter in the [documentation](https://quantumxt.github.io/openvslam/).

A sample ORB vocabulary file can be downloaded from [here](https://drive.google.com/open?id=1wUPb328th8bUqhOk-i8xllt5mgRW4n84).
Sample datasets are also provided at [here](https://drive.google.com/open?id=1A_gq8LYuENePhNHsuscLZQPhbJJwzAq4).

If you would like to run visual SLAM with standard benchmarking datasets (e.g. KITTI Odometry dataset), please see [**SLAM with standard datasets**](https://openvslam.readthedocs.io/en/master/example.html#slam-with-standard-datasets) section in the [documentation](https://openvslam.readthedocs.io/).
If you would like to run visual SLAM with standard benchmarking datasets (e.g. KITTI Odometry dataset), please see [**SLAM with standard datasets**](https://quantumxt.github.io/openvslam/example.html#slam-with-standard-datasets) section in the [documentation](https://quantumxt.github.io/openvslam/).

## Community

Expand Down

0 comments on commit d88bae9

Please sign in to comment.