diff --git a/vlib/sdl/README.md b/vlib/sdl/README.md index 0d48de3647..75fe1491e6 100644 --- a/vlib/sdl/README.md +++ b/vlib/sdl/README.md @@ -1,7 +1,8 @@ # sdl -SDL2 V module -- libSDL2 wrapper -Current APIs available/tested in examples : +SDL2 V module -- libSDL2 wrapper. + +Current APIs available/tested in examples: - basic graphics (2D drawing) - [Image](image/README.md) - TTF font (text rendering) @@ -10,48 +11,50 @@ Current APIs available/tested in examples : - music (MOD mixing) - more to come.. (networking ?) -# Support -sdl is supported on : -- linux (major distros) +## Support +sdl is supported on: +- Linux (major distros) - MacOS (brew) -- windows (msys2/mingw64 only for now) +- Windows -# Examples +## Examples [tVintris](examples/tvintris) -![tVintris screenshot](examples/tvintris/images/tvintris.png) +![tVintris screenshot](/examples/sdl/tvintris/images/tvintris.png) You can run the tVintris example from the V root folder like this : ``` v run vlib/sdl/examples/tvintris/tvintris.v ``` -# Dependencies +## Dependencies -## Linux -Fedora : +### Linux + +#### Fedora `$ sudo dnf install SDL2-devel SDL2_ttf-devel SDL2_mixer-devel SDL2_image-devel` -Ubuntu : +#### Ubuntu `$ sudo apt install libsdl2-ttf-dev libsdl2-mixer-dev libsdl2-image-dev` -ClearLinux : +#### ClearLinux `$ sudo swupd bundle-add devpkg-SDL2_ttf devpkg-SDL2_mixer devpkg-SDL2_image` -## MacOS -Brew : +### MacOS + +#### Brew `$ brew install sdl2 sdl2_gfx sdl2_ttf sdl2_mixer sdl2_image sdl2_net` If you get no music with the above, try: `$ brew reinstall --build-from-source --force sdl2 sdl2_gfx sdl2_image sdl2_mixer sdl2_net sdl2_ttf webp libtiff libmodplug libogg` -## Windows -Windows/MSYS2 : -`$ pacman -S mingw-w64-x86_64-SDL2_ttf mingw-w64-x86_64-SDL2_mixer mingw-w64-x86_64-SDL2_image` +### Windows -# Contributions +`$ .github\workflows\windows-install-sdl.bat` -nsauzede -spytheman -adlesh +## Contributions + +- nsauzede +- spytheman +- adlesh