document native dependencies

knzai · Jul 17, 2024 · cbbaf35 · cbbaf35
1 parent 1d94523
commit cbbaf35
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/Cargo.toml b/Cargo.toml
@@ -16,7 +16,7 @@ path = "src/main.rs"
 required-features = ["terminal"]
 
 [features]
-default = ["terminal", "sdl2", "png"]
+default = ["terminal", "png"]
 terminal = ["clap"]
 png = ["image"]
 

diff --git a/README.md b/README.md
@@ -13,6 +13,16 @@
 
 This is currently very much in an alpha state: apis and CLI arguments may still change heavily and the apis aren't documented. This file has decent usage examples below.
 
+## Installation dependencies
+
+If you use feature `sdl2` you must install the sdl2 libraries first
+
+## MacOS
+`brew install sdl2 sdl2_gfx sdl2_image`
+
+## Linux
+`[sudo] apt-get install libsdl2-dev libsdl2-gfx-dev libsdl2-image-dev`
+
 ## Roadmap/Upcoming
 
 ### Priority