README.md
1# tracy-rs
2
3This provides a Rust integration for the Tracy profiling library (https://bitbucket.org/wolfpld/tracy).
4
5## Usage
6
71) Clone the Tracy library from the above URL.
82) Follow the steps to build the profiler GUI (e.g. in tracy/profiler/build/unix/).
93) Follow the steps to build the profiler shared library (e.g. in tracy/library/unix).
104) Add this crate to your project dependencies, with the 'enable_profiler' cargo feature.
115) Call `tracy_rs::load` at the start of your application, providing path to library from (3).
126) Insert the main frame marker `tracy_frame_marker!();` at the end of your frame.
137) Optionally, add sub-frame markers with `tracy_begin_frame!()` and `tracy_end_frame!()`.
148) Annotate functions to be profiled with `profile_scope!()`.
159) Run the application and profiler GUI.
16