Skip to content

Commit

Permalink
docs: add installation instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
YifuTao committed Sep 6, 2024
1 parent c4f3170 commit d48d417
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,29 @@
# Oxford Spires Dataset
This repository contains scripts that are used to evaluate Lidar/Visual SLAM on the Oxford Spires Dataset.

## Installation
### oxford_spires_utils (Python)
```bash
pip install -e .
```

### octomap_utils (C++)
Install octomap to your system
```bash
git clone https://github.com/OctoMap/octomap.git && cd octomap
mkdir build && cd build
cmake ..
make
sudo make install
```
Then install the sripts in Spires.
```bash
cd <oxford_spires_dataset>/octomap_utils
mkdir build && cd build
cmake ..
make
```

## Contributing
Please refer to Angular's guide for contributing(https://github.com/angular/angular/blob/22b96b96902e1a42ee8c5e807720424abad3082a/CONTRIBUTING.md).

Expand Down

0 comments on commit d48d417

Please sign in to comment.