Add installation instructions to README

cambel · Jun 13, 2022 · 732dd21 · 732dd21
1 parent 20e608a
commit 732dd21
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,36 @@
 # Dual arm set up with Universal Robots (default UR3e)
+<img src="https://github.com/cambel/dual_ur3e/blob/main/docs/dual_ur3e.png?raw=true" alt="Dual UR3e & Robotiq Hand-e" width="500">
+
+
 ROS-Melodic, Gazebo, and MoveIt configuration for dual configuration with UR3e (or any other UR robot)
 
+## Installation
+### Prerequisites
+- Install Docker
+- Install Docker-compose
+- Install nvidia-docker2
+
+Detailed instruction can be found [here](https://github.com/cambel/ur3/wiki/Install-with-Docker)
+
+### Clone and build
+
+Clone this repository
+```shell
+git clone https://github.com/cambel/dual_ur3e.git
+```
+
+Build Docker container
+```shell
+cd dual_ur3e
+./BUILD-DOCKER-IMAGE.sh
+```
+
+Run container (reconnect to container with new terminals with this same script)
+```shell
+cd dual_ur3e
+./RUN-DOCKER.sh
+```
+
 ## Example
 ### Launch the Gazebo environment (Environment is a custom build of my lab)
 Execute the following command

diff --git a/docs/dual_ur3e.png b/docs/dual_ur3e.png