Skip to content

Commit 6d0629c

Browse files
Update README.md
1 parent fc67609 commit 6d0629c

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ ZeroSim provides a multitude of tools for building robots and environments in Un
4747
* Secure communications via WebSockets.
4848
* Support for other Physics engines such as Bullet or Havok.
4949

50+
## API Documentation
51+
52+
[API Documentation](https://fsstudio-team.github.io/ZeroSimROSUnity/api/index.html)
53+
5054
## Getting Started
5155

5256
### Recommended System
@@ -114,4 +118,4 @@ This will show visualizing the 2D LIDAR and ROS TF in RViz. This uses a VNC vie
114118
1. In a browser open http://localhost:8083/vnc.html
115119
2. Press the "Connect" button. ![noVNC Login](Documentation~/images/novnc_login.png)
116120
3. In the VNC window press the *LEFT* mouse button and select "Terminal". ![noVNC Terminal](Documentation~/images/novnc_terminal.png)
117-
4. In the new terminal run `rviz -d ./src/zero_sim_ros/rviz/turtlebot_viewer.rviz`. RViz will start up with a 3D view with the LIDAR scanner visibile. ![RViz Turtlebot Viewer](Documentation~/images/rviz_turtlebot.gif)
121+
4. In the new terminal run `rviz -d ./src/zero_sim_ros/rviz/turtlebot_viewer.rviz`. RViz will start up with a 3D view with the LIDAR scanner visibile. ![RViz Turtlebot Viewer](Documentation~/images/rviz_turtlebot.gif)

0 commit comments

Comments
 (0)