Skip to content

Commit

Permalink
Add examples/README
Browse files Browse the repository at this point in the history
  • Loading branch information
Dinnerbone committed Dec 2, 2024
1 parent 96e973f commit e51fc8d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions examples/README.mkd
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Examples for Tracy integration

These examples exist to demonstrate how to integrate the rust-Tracy API within an application.
They do not serve as examples of a real world application, but rather how an application would use a given API.

To use them, run `cargo run -p tracy-client-examples -- example_name` from within the repository root.
If you don't provide an `example_name`, it will list the available examples.

Be sure to have Tracy running and awaiting a connection, before running any example!

0 comments on commit e51fc8d

Please sign in to comment.