Add doc about debugging features in README

linebender · Jan 15, 2025 · 87ba6af · 87ba6af
1 parent 93a0d92
commit 87ba6af
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/masonry/README.md b/masonry/README.md
@@ -108,6 +108,12 @@ The following feature flags are available:
 - `tracy`: Enables creating output for the [Tracy](https://github.com/wolfpld/tracy) profiler using [`tracing-tracy`][tracing_tracy].
   This can be used by installing Tracy and connecting to a Masonry with this feature enabled.
 
+### Debugging features
+
+Masonry apps currently ship with two debugging features built in:
+- A rudimentary widget inspector - toggled by F11 key.
+- A debug mode painting widget layout rectangles - toggled by F12 key.
+
 [winit]: https://crates.io/crates/winit
 [Druid]: https://crates.io/crates/druid
 [Xilem]: https://crates.io/crates/xilem

diff --git a/masonry/src/lib.rs b/masonry/src/lib.rs
@@ -86,6 +86,12 @@
 //! - `tracy`: Enables creating output for the [Tracy](https://github.com/wolfpld/tracy) profiler using [`tracing-tracy`][tracing_tracy].
 //!   This can be used by installing Tracy and connecting to a Masonry with this feature enabled.
 //!
+//! ### Debugging features
+//!
+//! Masonry apps currently ship with two debugging features built in:
+//! - A rudimentary widget inspector - toggled by F11 key.
+//! - A debug mode painting widget layout rectangles - toggled by F12 key.
+//!
 //! [winit]: https://crates.io/crates/winit
 //! [Druid]: https://crates.io/crates/druid
 //! [Xilem]: https://crates.io/crates/xilem