Add 'packages' section to README and link to tracetools_analysis API docs
Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
This commit is contained in:
parent
b7b0018fbb
commit
f2a3755c7f
1 changed files with 12 additions and 0 deletions
12
README.md
12
README.md
|
@ -63,3 +63,15 @@ time_per_thread = cpu_util.get_time_per_thread()
|
|||
## Design
|
||||
|
||||
See the [`ros2_tracing` design document](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md), especially the [*Goals and requirements*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#goals-and-requirements) and [*Analysis*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#analysis) sections.
|
||||
|
||||
## Packages
|
||||
|
||||
### ros2trace_analysis
|
||||
|
||||
Package containing a `ros2cli` extension to perform trace analysis.
|
||||
|
||||
### tracetools_analysis
|
||||
|
||||
Package containing tools for analyzing trace data.
|
||||
|
||||
See the [API documentation](https://micro-ros.gitlab.io/ros_tracing/tracetools_analysis-api/).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue