update readme.md

README.md

@@ -43,6 +43,5 @@ By using ROSBridge, this GUI will attempt to display relevant information over t
 
 TODO:
 1. Display Network Information
-1. Add checkmarks for which topics you want to record
+1. Add checkmark to remove all topoics from being bagged
 2. Add time plot for data
-1. fix connectoin button on ROS Bridge Connection tab

README.md~

@@ -0,0 +1,48 @@
+# Asctec Pelican GUI
+
+The purpose of this project is an example of how to write a web page that can be accessed by any device on the same network as the host computer by accessing the IP of that host computer.
+
+### Quick Start Guide
+
+
+If you are connecting to a remote computer that is running the roscore, you need to run the following lines in the terminal:
+
+    sudo route add 192.168.2.1 gw <Host computer IP>
+    export ROS_MASTER_URI=http://<Host computer IP>:11311
+    export ROS_IP=<your IP>
+
+Make sure you have the web_video_server installed:
+
+	sudo apt-get install ros-indigo-web-video-server
+
+Make sure you have ROSBridge installed:
+
+	sudo apt-get install ros-indigo-rosbridge-suite
+
+Then run the bash file in the working directory by running the following in the terminal.
+
+    bash launch.bash
+
+#### Just display the webpage
+
+If you just want to test the webpage, navigate to the working directory in the terminal and type
+
+    python -m SimpleHTTPServer
+
+Then open http://localhost:8000/.
+# Making Changes
+
+Feel free to clone this project and use it as a base for your own GUI.
+
+You can easily customise the "Robot Display" pannel by changing the HTML "robot\_display.html" file.
+
+All ROS related Javascript should go in the "ProjectFiles/js/ros_scripts.js" file.
+All functions that are used to update the GUI should go in the "ProjectFiles/js/update_guis.js" file
+
+By using ROSBridge, this GUI will attempt to display relevant information over the web for any device.
+
+TODO:
+1. Display Network Information
+1. Add checkmarks for which topics you want to record
+2. Add time plot for data
+1. fix connectoin button on ROS Bridge Connection tab