Documentation Updates

- Add page links at the top of each website page
- Add link to draft video to home.md
- Fix links that don't point to files in the docs folder to point to file in GitHub repo
- Add instructions for using run_all.sh script to gear.md
- Add documentation.md to describe file structure and what each of the files are for
This commit is contained in:
Sravan Balaji
2020-04-27 12:35:02 -04:00
parent 271222645d
commit 1490e427bd
3 changed files with 159 additions and 32 deletions

View File

@@ -1,5 +1,10 @@
# RRRobot! <!-- omit in toc -->
## Page Links <!-- omit in toc -->
- [Home](home.md)
- [Documentation](documentation.md)
- [GEAR](gear.md)
## Table of Contents <!-- omit in toc -->
- [Contributors](#contributors)
- [Documents](#documents)
@@ -8,9 +13,10 @@
- [Docker Compose Services](#docker-compose-services)
- [GUI Support](#gui-support)
- [Running Docker Containers](#running-docker-containers)
- [Gazebo Grasping Simulation (Testing)](#gazebo-grasping-simulation-testing)
- [GEAR Simulation (Final)](#gear-simulation-final)
- [Gazebo Grasping Simulation](#gazebo-grasping-simulation)
- [Tips & Tricks](#tips--tricks)
- [Source Code Documentation](#source-code-documentation)
- [GEAR Final Simulation](#gear-final-simulation)
## Contributors
@@ -31,7 +37,8 @@
1. [Project Poster](1.%20Project%20Poster.pdf)
2. [Project Proposal](2.%20Project%20Proposal.pdf)
3. [Final Project - Overleaf (Read-Only)](https://www.overleaf.com/read/ncvksrzpvbmr)
3. [Final Project Report - Overleaf (Read-Only)](https://www.overleaf.com/read/ncvksrzpvbmr)
4. [Draft Video](https://youtu.be/powEVDPQNEY)
## Introduction
@@ -39,6 +46,10 @@ 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).
Once installed, you can run our final simulation by following the instructions on the [GEAR](gear.md) page.
Information about our source code can be found on the [Documentation](documentation.md) page.
## Development Guide
At this point, you should have Docker Desktop, Toolbox, or Engine setup on your host system. In this section, you will find a list of the different docker-compose services available and how to run them.
@@ -67,7 +78,7 @@ The GEAR container includes the Gazebo Environment for Agile Robotics from the A
### GUI Support
If using VcXsrv for Windows to enable GUI applications, run XLaunch using [config.xlaunch](utils/config.xlaunch). This will enable the following settings:
If using VcXsrv for Windows to enable GUI applications, run XLaunch using [config.xlaunch](https://github.com/EECS-467-W20-RRRobot-Project/RRRobot/blob/master/utils/config.xlaunch). This will enable the following settings:
- Display Settings
- Multiple Windows
@@ -91,7 +102,12 @@ libGL error: failed to load driver: swrast
As mentioned in [No libGL libraries when running Gazebo from ROS](https://github.com/microsoft/WSL/issues/3644#issuecomment-434556680), this can be resolved by disabling `No native OpenGL` in the VcXsrv configuration.
Additionally, be sure to update the `IP_ADDRESS` variable in [.env](src/.env) with your computer's IP Address to enable X forwarding.
You will need to update your environment variable with your IP Address to enable X forwarding. You can create a file called **.env** in the same directory as the docker-compose.yml file with your IP address as shown below. You can also edit the [docker-compose.yml](https://github.com/EECS-467-W20-RRRobot-Project/RRRobot/blob/master/docker_env/docker-compose.yml) to remove the dependence on the `IP_ADDRESS` environment variable.
```
# .env for docker-compose
IP_ADDRESS=<IP Address Here>
```
### Running Docker Containers
@@ -103,10 +119,10 @@ Additionally, be sure to update the `IP_ADDRESS` variable in [.env](src/.env) wi
- Other: `docker-machine env`
3. Navigate to src folder
- `cd /PATH/TO/rrrobot/src`
4. Use Docker Compose to run a service (refer to [docker-compose.yml](src/docker-compose.yml) or [Docker Compose Services](#docker-compose-services))
4. Use Docker Compose to run a service (refer to [docker-compose.yml](https://github.com/EECS-467-W20-RRRobot-Project/RRRobot/blob/master/docker_env/docker-compose.yml) or [Docker Compose Services](#docker-compose-services))
- `docker-compose run --rm <service_name>`
### Gazebo Grasping Simulation (Testing)
### Gazebo Grasping Simulation
1. Source ROS Setup
- `source /opt/ros/melodic/setup.bash`
@@ -119,10 +135,6 @@ Additionally, be sure to update the `IP_ADDRESS` variable in [.env](src/.env) wi
- `gazebo /app/rrrobot_src/world/rrrobot.world`
5. Run control and perception programs
### GEAR Simulation (Final)
Instructions for working in the GEAR Simulation can be found on the [GEAR](gear.md) page.
### Tips & Tricks
- Clear space on docker machine
@@ -131,3 +143,11 @@ Instructions for working in the GEAR Simulation can be found on the [GEAR](gear.
- `docker ps`
- Attach a new terminal to a running container
- `docker exec -it -u root <container> bash`
## Source Code Documentation
Documentation on our source code can be found on the [Documentation](documentation.md) page.
## GEAR Final Simulation
Instructions for running our final GEAR simulation can be found on the [GEAR](gear.md) page.