From afa4cb9cd4e54cde8521c5fac5b20cab8f37fbcf Mon Sep 17 00:00:00 2001 From: ZacJW Date: Sat, 15 Nov 2025 18:25:19 +0000 Subject: [PATCH] Add crate-level doc comment --- src/lib.rs | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 07a95d9..e7976fa 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,19 @@ +//! Low-level Rust bindings for libburn. +//! +//! You can find out more about the libburnia project, of which libburn is a part, by visiting +//! +//! +//! This version of libburn-sys is based on libburn 1.5.6 +//! +//! ## Requirements +//! +//! Currently, libburn-sys does not support statically linking libburn into your application, and may never do. +//! Instead, **you must have libburn 1.5.6 or greater installed** on your system so libburn-sys can dynamically +//! link to it. +//! +//! Bindings for libburn are pregenerated for libburn-sys, so you shouldn't need bindgen's dependencies +//! installed to start using libburn-sys. + /* automatically generated by rust-bindgen 0.72.1 */ #[repr(C)]