From ade1ba57184e4deaa071d0fd33c11b007bb2ed49 Mon Sep 17 00:00:00 2001
From: Gwilym Inzani <email@gwilym.dev>
Date: Sat, 3 Feb 2024 20:22:06 +0000
Subject: [PATCH] Also include the docs in the agb lib itself

---
 agb/src/lib.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/agb/src/lib.rs b/agb/src/lib.rs
index 44d3615b..c7483b93 100644
--- a/agb/src/lib.rs
+++ b/agb/src/lib.rs
@@ -97,6 +97,15 @@
 /// bg.show();
 /// # }
 /// ```
+///
+/// Including from the out directory is supported through the `$OUT_DIR` token.
+///
+/// ```rust,ignore
+/// # #![no_std]
+/// # #![no_main]
+/// # use agb::include_background_gfx;
+/// include_background_gfx!(generated_background, "000000", DATA => "$OUT_DIR/generated_background.aseprite");
+/// ```
 pub use agb_image_converter::include_background_gfx;
 
 #[doc(hidden)]