sravan/RRRobot
1
0
Fork 0
mirror of https://github.com/EECS-467-W20-RRRobot-Project/RRRobot.git synced 2025-08-26 01:32:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

README Updates

Browse Source 
- Add course staff to list of contributors
- Make filepath links consistent (no leading ./)
- Remove CAD model links (moved to google doc)
- Add section with instructions on running containers
This commit is contained in:
Sravan Balaji
2020-03-22 21:20:27 -04:00
parent 718a3e070e
commit 15b40071aa
1 changed files with 25 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@@ -1,15 +1,23 @@
# RRRobot! # RRRobot!
## Team ## Contributors
### Project Team
- Sravan Balaji ([balajsra@umich.edu](mailto:balajsra@umich.edu)) - Sravan Balaji ([balajsra@umich.edu](mailto:balajsra@umich.edu))
- Chenxi Gu ([chenxgu@umich.edu](mailto:chenxgu@umich.edu)) - Chenxi Gu ([chenxgu@umich.edu](mailto:chenxgu@umich.edu))
- Jake Johnson ([thejakej@umich.edu](mailto:thejakej@umich.edu)) - Jake Johnson ([thejakej@umich.edu](mailto:thejakej@umich.edu))
- Derek Witcpalek ([dwitcpa@umich.edu](mailto:dwitcpa@umich.edu)) - Derek Witcpalek ([dwitcpa@umich.edu](mailto:dwitcpa@umich.edu))
### EECS 467 W20 Course Staff
- Prof. Chad Jenkins ([ocj@umich.edu](mailto:ocj@umich.edu))
- Xiaotong Chen ([cxt@umich.edu](mailto:cxt@umich.edu))
- Jana Pavlasek ([pavlasek@umich.edu](mailto:pavlasek@umich.edu))
## Documents ## Documents
1. [Project Poster](./Documents/1.%20Project%20Poster.pdf) 1. [Project Poster](Documents/1.%20Project%20Poster.pdf)
2. [Project Proposal](Documents/2.%20Project%20Proposal.pdf) 2. [Project Proposal](Documents/2.%20Project%20Proposal.pdf)
## Introduction ## Introduction
@@ -18,17 +26,19 @@ Repository for UMICH EECS 467: Autonomous Robotics (W20) RRRobot! project.
To get started, you will need to install Docker on your system. Information on what Docker is, how to install it, and how to use it can be found in [Getting Started with Docker](https://sravanbalaji.com/Web%20Pages/blog_docker.html). To get started, you will need to install Docker on your system. Information on what Docker is, how to install it, and how to use it can be found in [Getting Started with Docker](https://sravanbalaji.com/Web%20Pages/blog_docker.html).
## CAD Models of Items for Simulation ## Running Containers
- Snack **NOTE:** If using VcXsrv for Windows to enable GUI applications, run XLaunch using [config.xlaunch](utils/config.xlaunch).
- https://www.turbosquid.com/3d-models/free-cheez-it-white-cheddar-snack-3d-model/783634
- Plastic Bottle **NOTE:** To enable X forwarding, be sure to update the `IP_ADDRESS` variable in [.env](src/.env) with your computer's IP Address.
- https://www.turbosquid.com/3d-models/free-water-bottles-3d-model/582482
- Paper Bag 1. Start Docker Machine (default)
- https://www.turbosquid.com/3d-models/3d-paper-bag-model-1190189 - WSL: `docker-machine.exe start default`
- Glass - Other: `docker-machine start default`
- https://www.turbosquid.com/3d-models/free-max-mode-drinking-glass/345178 2. Set Docker Machine Environment
- Can - WSL: `docker-machine.exe env`
- https://www.turbosquid.com/3d-models/free-3ds-model-energy-drink/673830 - Other: `docker-machine env`
- Cardboard 3. Navigate to src folder
- https://www.turbosquid.com/3d-models/cardboard-package-box-max-free/1138736 - `cd /PATH/TO/rrrobot/src`
4. Use Docker Compose to run a service (refer to [docker-compose.yml](src/docker-compose.yml) for a list of services)
- `docker-compose run --rm <service_name>`