Added static_bundled_build, imported readme into the crate document…

…ation

Cargo.toml

@@ -7,7 +7,7 @@ edition = "2021"
 
 [dependencies]
 # Core
-fermium = { version  = "22605", default-features = false }
+fermium = { version = "22605", default-features = false }
 glow = "0.14"
 bytemuck = { version = "1.9", features = ["derive"] }
 glam = { version = "0.28", features = ["bytemuck"] }
@@ -23,4 +23,5 @@ rand = "0.8"
 
 [features]
 default = ["ldtk"]
-ldtk = ["serde", "serde_json"]
+ldtk = ["serde", "serde_json"]
+static_bundled_build = ["fermium/static_bundled_build"]

README.md

@@ -7,7 +7,12 @@ on between 2018 and 2022. It aims to be smaller and simpler, with less global st
 
 **⚠️ Use at your own risk!** This framework is still very experimental, and the API is constantly in flux. No support is offered, but you are welcome to use to the code as reference or fork it for your own needs.
 
+## Features
+
+- `ldtk` (enabled by default): enables a module to load [ldtk](https://ldtk.io/) files.
+- `static_bundled_build`: enables automatic SDL2 library building and linking. Building SDL2 can take a bit during that first build (usually 1 minute or more).
+
 ## Notes
 
-* This framework is very heavily inspired by [FNA](https://github.com/FNA-XNA/FNA), and NoelFB's lightweight game engines ([Blah](https://github.com/NoelFB/blah) and [Foster](https://github.com/NoelFB/Foster)).
-* It depends on [SDL2](https://www.libsdl.org/) for interacting with the underlying platform.
+- This framework is very heavily inspired by [FNA](https://github.com/FNA-XNA/FNA), and NoelFB's lightweight game engines ([Blah](https://github.com/NoelFB/blah) and [Foster](https://github.com/NoelFB/Foster)).
+- It depends on [SDL2](https://www.libsdl.org/) for interacting with the underlying platform.

src/lib.rs

@@ -1,7 +1,7 @@
 #![allow(clippy::new_without_default)]
+#![doc = include_str!("../README.md")]
 
 // ===== Core =====
-
 pub mod app;
 pub mod fs;
 pub mod graphics;