doc: Add supported sdl versions (#36)

MikuroXina · Jan 29, 2023 · fd1e75c · fd1e75c
1 parent 4fcff54
commit fd1e75c
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -8,6 +8,16 @@
 //!
 //! The rich-sdl2-rust provides wrapper for SDL2 and abstractions of that APIs, [`audio`], [`window`], [`EventBox`] and so on.
 //!
+//! ## Supported SDL versions
+//!
+//! This crate works with libraries:
+//!
+//! - SDL 2.26.2 or later,
+//! - SDL_ttf 2.20.1 or later (on `ttf` feature),
+//! - SDL_mixer 2.6.2 or later (on `mixer` feature),
+//! - SDL_image 2.6.2 or later (on `image` feature),
+//! - SDL_net 2.2.0 or later (on `net` feature).
+//!
 //! ## Module Navigation
 //!
 //! - [Window and Graphics](window)