diff --git a/README.md b/README.md index 5716d86..fa1f748 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,8 @@ from tracetools_analysis import loading from tracetools_analysis import processor from tracetools_analysis import utils -# Load converted trace file -events = loading.load_file('/path/to/converted/file') +# Load trace directory or converted trace file +events = loading.load_file('/path/to/trace/or/converted/file') # Process ros2_handler = processor.Ros2Handler() @@ -67,4 +67,4 @@ 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 architecture*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#analysis-architecture) sections. +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.