Update readme to include instuructions to create branch
This commit is contained in:
14
README.md
14
README.md
@@ -2,8 +2,9 @@
|
||||
|
||||
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
|
||||
The best way to contribute to this project is to make a new brach from the master branch called the name of the robot that it is used for. This will also alow maximum colaberation between labs.
|
||||
|
||||
### 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:
|
||||
|
||||
@@ -21,7 +22,7 @@ Make sure you have ROSBridge installed:
|
||||
|
||||
Then run the bash file in the working directory by running the following in the terminal.
|
||||
|
||||
bash launch.bash
|
||||
. launch.bash
|
||||
|
||||
#### Just display the webpage
|
||||
|
||||
@@ -34,14 +35,21 @@ Then open http://localhost:8000/.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
Working on:
|
||||
1. adding a simple messaging input to the robot tab
|
||||
|
||||
TODO:
|
||||
1. Display Network Information
|
||||
1. Add checkmark to remove all topoics from being bagged
|
||||
1. use javascript to get host pc's IP address
|
||||
2. Add time plot for data
|
||||
2. separate the update\_gui and ros.js functions for robot tab
|
||||
2. add cookie to remember which topics you bagged last time
|
||||
2. Add chat window
|
||||
|
||||
Reference in New Issue
Block a user