diff --git a/docs/home.md b/docs/home.md index e0cd4f8..41b7fea 100644 --- a/docs/home.md +++ b/docs/home.md @@ -2,6 +2,11 @@ ## Table of Contents - [Contributors](#contributors) +- [Dataset](#dataset) +- [Libraries](#libraries) +- [Docker](#docker) + - [Install & Setup](#install--setup) + - [Running Container](#running-container) ## Contributors @@ -18,3 +23,29 @@ - Maani Ghaffari ([maanigj@umich.edu](mailto:maanigj@umich.edu)) - Tzu-Yuan (Justin) Lin ([tzuyuan@umich.edu](mailto:tzuyuan@umich.edu)) - Peter Westra ([pwestra@umich.edu](mailto:pwestra@umich.edu)) + +## Dataset + +[The University of Michigan North Campus Long-Term Vision and LIDAR Dataset](http://robots.engin.umich.edu/nclt/) + +## Libraries + +- [OpenCV](https://opencv.org/) +- [Point Cloud Library](http://pointclouds.org/) +- [NumPy](https://numpy.org/) +- [Scipy](https://www.scipy.org/) +- [Matplotlib](https://matplotlib.org/) +- [Natural Language Toolkit](https://www.nltk.org/) + +## Docker + +### Install & Setup + +For instructions on installing and setting up Docker, see [Getting Started with Docker](https://sravanbalaji.com/Web%20Pages/blog_docker.html) on Sravan's website. + +### Running Container + +After cloning the repo, start your docker machine and following commands shown below in your docker terminal. + +1. `cd /PATH/TO/UMICH_NCLT_SLAP/src` +2. `docker-compose run --rm python-dev`