From eef5c536687750123bc3b9ef50b781684895a405 Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Wed, 29 Nov 2023 12:31:27 -0500 Subject: [PATCH] docs: Moved CREDITS and INSTALL to markdown format. --- CREDITS.md | 34 ++++++++++++++++++++++++++++ CREDITS.txt | 53 -------------------------------------------- INSTALL.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++ INSTALL.txt | 43 ----------------------------------- 4 files changed, 98 insertions(+), 96 deletions(-) create mode 100644 CREDITS.md delete mode 100644 CREDITS.txt create mode 100644 INSTALL.md delete mode 100644 INSTALL.txt diff --git a/CREDITS.md b/CREDITS.md new file mode 100644 index 000000000..370bcec0f --- /dev/null +++ b/CREDITS.md @@ -0,0 +1,34 @@ +# Simple DirectMedia Layer CREDITS + +Thanks to everyone who made this possible, including: + +- Cliff Matthews, for giving me a reason to start this project. :) -- Executor rocks! *grin* +- Ryan Gordon for helping everybody out and keeping the dream alive. :) +- Gabriel Jacobo for his work on the Android port and generally helping out all around. +- Philipp Wiesemann for his attention to detail reviewing the entire SDL code base and proposes patches. +- Andreas Schiffler for his dedication to unit tests, Visual Studio projects, and managing the Google Summer of Code. +- Mike Sartain for incorporating SDL into Team Fortress 2 and cheering me on at Valve. +- Alfred Reynolds for the game controller API and general (in)sanity +- Jørgen Tjernø¸ for numerous magical macOS fixes. +- Pierre-Loup Griffais for his deep knowledge of OpenGL drivers. +- Julian Winter for the SDL 2.0 website. +- Sheena Smith for many months of great work on the SDL wiki creating the API documentation and style guides. +- Paul Hunkin for his port of SDL to Android during the Google Summer of Code 2010. +- Eli Gottlieb for his work on shaped windows during the Google Summer of Code 2010. +- Jim Grandpre for his work on multi-touch and gesture recognition during + the Google Summer of Code 2010. +- Edgar "bobbens" Simo for his force feedback API development during the + Google Summer of Code 2008. +- Aaron Wishnick for his work on audio resampling and pitch shifting during + the Google Summer of Code 2008. +- Holmes Futrell for his port of SDL to the iPhone and iPod Touch during the + Google Summer of Code 2008. +- Jon Atkins for SDL_image, SDL_mixer and SDL_net documentation. +- Everybody at Loki Software, Inc. for their great contributions! + + And a big hand to everyone else who has contributed over the years. + +THANKS! :) + + -- Sam Lantinga + diff --git a/CREDITS.txt b/CREDITS.txt deleted file mode 100644 index 3243318b0..000000000 --- a/CREDITS.txt +++ /dev/null @@ -1,53 +0,0 @@ - -Simple DirectMedia Layer CREDITS -Thanks to everyone who made this possible, including: - -* Cliff Matthews, for giving me a reason to start this project. :) - -- Executor rocks! *grin* - -* Ryan Gordon for helping everybody out and keeping the dream alive. :) - -* Gabriel Jacobo for his work on the Android port and generally helping out all around. - -* Philipp Wiesemann for his attention to detail reviewing the entire SDL code base and proposes patches. - -* Andreas Schiffler for his dedication to unit tests, Visual Studio projects, and managing the Google Summer of Code. - -* Mike Sartain for incorporating SDL into Team Fortress 2 and cheering me on at Valve. - -* Alfred Reynolds for the game controller API and general (in)sanity - -* Jørgen Tjernø for numerous magical macOS fixes. - -* Pierre-Loup Griffais for his deep knowledge of OpenGL drivers. - -* Julian Winter for the SDL 2.0 website. - -* Sheena Smith for many months of great work on the SDL wiki creating the API documentation and style guides. - -* Paul Hunkin for his port of SDL to Android during the Google Summer of Code 2010. - -* Eli Gottlieb for his work on shaped windows during the Google Summer of Code 2010. - -* Jim Grandpre for his work on multi-touch and gesture recognition during - the Google Summer of Code 2010. - -* Edgar "bobbens" Simo for his force feedback API development during the - Google Summer of Code 2008. - -* Aaron Wishnick for his work on audio resampling and pitch shifting during - the Google Summer of Code 2008. - -* Holmes Futrell for his port of SDL to the iPhone and iPod Touch during the - Google Summer of Code 2008. - -* Jon Atkins for SDL_image, SDL_mixer and SDL_net documentation. - -* Everybody at Loki Software, Inc. for their great contributions! - - And a big hand to everyone else who has contributed over the years. - -THANKS! :) - - -- Sam Lantinga - diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 000000000..f071eab0f --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,64 @@ +# To compile and install SDL: + +## Windows with Visual Studio: + +Read ./docs/README-visualc.md + +## Windows building with mingw-w64 for x86: + +Run: `cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=build-scripts/cmake-toolchain-mingw64-i686.cmake && cmake --build build && cmake --install build` + +## Windows building with mingw-w64 for x64: + +Run: `cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=build-scripts/cmake-toolchain-mingw64-x86_64.cmake && cmake --build build && cmake --install build` + +## macOS with Xcode: + +Read docs/README-macos.md + +## macOS from the command line: + +Run: `cmake -S . -B build && cmake --build build && cmake --install build` + +## Linux and other UNIX systems: + +Run: `cmake -S . -B build && cmake --build build && cmake --install build` + +## Android: + +Read docs/README-android.md + +## iOS: + +Read docs/README-ios.md + +## Using CMake: + +Read docs/README-cmake.md + +# Example code + +Look at the example programs in ./test, and check out the online +documentation at https://wiki.libsdl.org/SDL3/ + +# Discussion + +## Forums/mailing lists + +Join the SDL developer discussions, sign up on + +https://discourse.libsdl.org/ + +and go to the development forum + +https://discourse.libsdl.org/c/sdl-development/6 + +Once you sign up, you can use the forum through the website, or as a mailing +list from your email client. + +## Announcement list + +Sign up for the announcement list through the web interface: + +https://www.libsdl.org/mailing-list.php + diff --git a/INSTALL.txt b/INSTALL.txt deleted file mode 100644 index 9faadeb0f..000000000 --- a/INSTALL.txt +++ /dev/null @@ -1,43 +0,0 @@ - -To compile and install SDL: - - 1. Windows with Visual Studio: - * Read ./docs/README-visualc.md - - Windows building with mingw-w64 for x86: - * Run: cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=build-scripts/cmake-toolchain-mingw64-i686.cmake && cmake --build build && cmake --install build - - Windows building with mingw-w64 for x64: - * Run: cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=build-scripts/cmake-toolchain-mingw64-x86_64.cmake && cmake --build build && cmake --install build - - macOS with Xcode: - * Read docs/README-macos.md - - macOS from the command line: - * Run: cmake -S . -B build && cmake --build build && cmake --install build - - Linux and other UNIX systems: - * Run: cmake -S . -B build && cmake --build build && cmake --install build - - Android: - * Read docs/README-android.md - - iOS: - * Read docs/README-ios.md - - Using Cmake: - * Read docs/README-cmake.md - - 2. Look at the example programs in ./test, and check out the online - documentation at https://wiki.libsdl.org/ - - 3. Join the SDL developer discussions, sign up on - https://discourse.libsdl.org/ - and go to the development forum - https://discourse.libsdl.org/c/sdl-development/6 - - 4. Sign up for the announcement list through the web interface: - https://www.libsdl.org/mailing-list.php - -That's it! -Sam Lantinga