Skip to content

Commit fa39cbe

Browse files
authored
Enhance README with example link for path tracking
Added a link to an example comparing Pure Pursuit and Stanley path tracking models in the README.
1 parent dfeacd7 commit fa39cbe

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Two well-known path tracking controllers are the Pure Pursuit [1] and the Stanle
2121
To generalize the computation of the path tracking error (and therefore the interface of the local path planner and the path tracking controller), [3] has proposed a classification of path tracking error definitions and also listed the required path operations (e.g. intersection of line/circle with path).
2222
This repository implements these operations (and other such as frenet transformation) for different represenations of 2-dimensional paths.
2323

24+
Run this [example](https://github.com/gnestlinger/Path2D/blob/main/examples/exPathTrackErr.m) for a comparison of Pure Pursuit and Stanley path tracking models.
25+
2426
## Quick Start
2527
```matlab
2628
% Example: Create a PolygonPath from waypoints and visualize the path
@@ -53,7 +55,7 @@ help SplinePath % Spline path
5355
```
5456

5557
## Examples
56-
See the [examples] (https://github.com/gnestlinger/Path2D/tree/main/examples) folder.
58+
See the [examples](https://github.com/gnestlinger/Path2D/tree/main/examples) folder.
5759

5860
### Intersection of spline path with a circle
5961
<img src="https://user-images.githubusercontent.com/84226458/233801288-a0665561-353f-4edc-a8e8-89793ea8414b.svg" width="500">

0 commit comments

Comments
 (0)