Updated instructions to include git submodules

Author: at669

Documentation/1_set_up_the_scene.md

@@ -14,20 +14,13 @@ In this first part of the tutorial, we will start by downloading and installing
 
 ### <a name="reqs">Requirements</a>
 
-To follow this tutorial you need to **clone** this repository even if you want to create your Unity project from scratch.
+To follow this tutorial you need to **clone** this repository even if you want to create your Unity project from scratch. 
 
-
-  > Note For Windows users: You need to have a software enabling you to run bash files. One option is to download [GIT](https://git-scm.com/downloads). During installation of GIT, add GIT Bash to windows context menu by selecting its option. After installation, right click in your folder, and select [GIT Bash Here](Images/0_GIT_installed.png).
+>Note: This project uses Git Submodules to grab the ROS package dependencies for the `universal_robot`, `moveit_msgs`, `ros_tcp_endpoint`, and the `robotiq` folders. If you cloned the project and forgot to use `--recurse-submodules`, or if any submodule in this directory doesn't have content (e.g. moveit_msgs or ros_tcp_endpoint), you can run the following command to grab the Git submodules. 
 
 1. Open a terminal and put yourself where you want to host the repository. 
 ```bash
-git clone https://github.com/Unity-Technologies/Unity-Robotics-Hub.git
-```
-
-Then we need to be in the `Unity-Robotics-Hub/tutorials/object_pose_estimation` folder and generate the contents of the `universal_robot`, `moveit_msgs`, `ros_tcp_endpoint`, and the `robotiq` folders. 
-```bash
-cd Unity-Robotics-Hub/tutorials/object_pose_estimation
-./submodule.sh
+git clone --recurse-submodules https://github.com/Unity-Technologies/Object-Pose-Estimation.git
 ```
 
 2. [Install Unity `2020.2.*`.](install_unity.md)

Documentation/4_pick_and_place.md

@@ -25,21 +25,13 @@ In this part, we will use our trained deep learning model to predict the pose of
 ### <a name="setup">Set up</a>
 If you have correctly followed parts 1 and 2, whether or not you choose to use the Unity project given by us or start it from scratch, you should have cloned the repository. 
 
+>Note: This project uses Git Submodules to grab the ROS package dependencies for the [`universal_robot`](https://github.com/ros-industrial/universal_robot), [`moveit_msgs`](https://github.com/ros-planning/moveit_msgs), [`ros_tcp_endpoint`](https://github.com/Unity-Technologies/ROS-TCP-Endpoint), and the [`robotiq`](https://github.com/ros-industrial/robotiq) folders. If you cloned the project and forgot to use `--recurse-submodules`, or if any submodule in this directory doesn't have content (e.g. moveit_msgs or ros_tcp_endpoint), you can run the following command to grab the Git submodules. 
+> ```bash
+> cd /PATH/TO/Object-Pose-Estimation &&
+> git submodule update --init --recursive 
+> ```
 
->Note: If you cloned the project and forgot to use `--recurse-submodules`, or if any submodule in this directory doesn't have content (e.g. moveit_msgs or ros_tcp_endpoint), you can run the following command to grab the Git submodules. But before you need to be in the `object_pose_estimation` folder. 
->```bash
->cd /PATH/TO/Unity-Robotics-Hub/tutorials/object_pose_estimation &&
->git submodule update --init --recursive 
->```
-
-Three package dependencies for this project, [Universal Robot](https://github.com/ros-industrial/universal_robot) for the UR3 arm configurations, [Robotiq](https://github.com/ros-industrial/robotiq) for the gripper, and [MoveIt Msgs](https://github.com/ros-planning/moveit_msgs) are large repositories. A bash script has been provided to run a sparse clone to only copy the files required for this tutorial, as well as the [ROS TCP Endpoint](https://github.com/Unity-Technologies/ROS-TCP-Endpoint/).
-
-1. Open a terminal and go to the directory of the `object_pose_estimation` folder. Then run:
-```bash
-./submodule.sh 
-```
-
-In your `object_pose_estimation` folder, you should have a `ROS` folder. Inside that folder you should have a `src` folder and inside that one 5 folders: `moveit_msgs`, `robotiq`, `ros_tcp_endpoint`, `universal_robot` and `ur3_moveit`. 
+In your ROS/src folder, you should now have five subdirectories: `moveit_msgs`, `robotiq`, `ros_tcp_endpoint`, `universal_robot` and `ur3_moveit`. 
 
 ### <a name="step-2">Adding the Pose Estimation Model</a>
 

Documentation/quick_demo_full.md

@@ -17,24 +17,12 @@ If you just want to run the completed project, this section can help you get up
 
 You will first need to **clone** this repository. 
 
->Note For Windows Users:
-You need to have a software enabling you to run bash files. One option is to download [GIT](https://git-scm.com/downloads). During installation of GIT, add GIT Bash to windows context menu by selecting its option. After installation right click in your folder select [GIT Bash Here](Images/0_GIT_installed.png).
-
 1. Open a terminal and put yourself where you want to host the repository. 
-
-```bash
-git clone https://github.com/Unity-Technologies/Unity-Robotics-Hub.git
-```
-
-Three package dependencies for this project, [Universal Robot](https://github.com/ros-industrial/universal_robot) for the UR3 arm configurations, [Robotiq](https://github.com/ros-industrial/robotiq) for the gripper, and [MoveIt Msgs](https://github.com/ros-planning/moveit_msgs) are large repositories. A bash script has been provided to run a sparse clone to only copy the files required for this tutorial, as well as the [ROS TCP Endpoint](https://github.com/Unity-Technologies/ROS-TCP-Endpoint/).
-
-2. Still in the same terminal, run:
 ```bash
-cd Unity-Robotics-Hub/tutorials/object_pose_estimation
-./submodule.sh 
+git clone --recurse-submodules https://github.com/Unity-Technologies/Object-Pose-Estimation.git
 ```
 
-3. [Install Unity `2020.2.*`.](install_unity.md)
+2. [Install Unity `2020.2.*`.](install_unity.md)
 
 ## <a name='setup'>Setup</a>
 

Documentation/troubleshooting.md

@@ -60,7 +60,7 @@
 </p>
 
 ### Docker, ROS-TCP Connection
-- Building the Docker image may throw an `Could not find a package configuration file provided by...` exception if one or more of the directories in ROS/ appears empty. Ensure you have run the `submodule.sh` script to populate the ROS packages.
+- Building the Docker image may throw an `Could not find a package configuration file provided by...` exception if one or more of the directories in ROS/ appears empty. This project uses Git Submodules to grab the ROS package dependencies. If you cloned the project and forgot to use `--recurse-submodules`, or if any submodule in this directory doesn't have content, you can run the `git submodule update --init --recursive` to grab the Git submodules. 
 - `...failed because unknown error handler name 'rosmsg'` This is due to a bug in an outdated package version. Try running `sudo apt-get update && sudo apt-get upgrade` to upgrade packages.
 - `Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?` The system-independent `docker info` command can verify whether or not Docker is running. This command will throw a `Server: ERROR` if the Docker daemon is not currently running, and will print the appropriate [system-wide information](https://docs.docker.com/engine/reference/commandline/info/) otherwise. 
 - Occasionally, not having enough memory allocated to the Docker container can cause the `server_endpoint` to fail. This may cause unexpected behavior during the pick-and-place task, such as constantly predicting the same pose. If this occurs, check your Docker settings. You may need to increase the `Memory` to 8GB.