From e79067792520ee0272d31e923a4721cfef1400e2 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Wed, 22 Jan 2025 13:51:16 -0800
Subject: [PATCH] Updated documentation
---
docs/INTRO-androidstudio.md | 2 +-
docs/INTRO-cmake.md | 4 ++--
docs/INTRO-emscripten.md | 9 ++-------
docs/INTRO-visualstudio.md | 13 +++++++------
docs/INTRO-xcode.md | 4 ++--
5 files changed, 14 insertions(+), 18 deletions(-)
diff --git a/docs/INTRO-androidstudio.md b/docs/INTRO-androidstudio.md
index a43e74f7..53ab3197 100644
--- a/docs/INTRO-androidstudio.md
+++ b/docs/INTRO-androidstudio.md
@@ -1,5 +1,5 @@
-# Introduction to SDL with Android Studio
+# Introduction to SDL_image with Android Studio
A complete example is available at:
diff --git a/docs/INTRO-cmake.md b/docs/INTRO-cmake.md
index 7504acf6..5f943677 100644
--- a/docs/INTRO-cmake.md
+++ b/docs/INTRO-cmake.md
@@ -1,7 +1,7 @@
-# Introduction to SDL with CMake
+# Introduction to SDL_image with CMake
-The easiest way to use SDL is to include it as a subproject in your project.
+The easiest way to use SDL_image is to include it along with SDL as subprojects in your project.
We'll start by creating a simple project to build and run [hello.c](hello.c)
diff --git a/docs/INTRO-emscripten.md b/docs/INTRO-emscripten.md
index bff0f79e..d469ecf8 100644
--- a/docs/INTRO-emscripten.md
+++ b/docs/INTRO-emscripten.md
@@ -1,7 +1,7 @@
-# Introduction to SDL with Emscripten
+# Introduction to SDL_image with Emscripten
-The easiest way to use SDL is to include it as a subproject in your project.
+The easiest way to use SDL_image is to include it along with SDL as subprojects in your project.
We'll start by creating a simple project to build and run [hello.c](hello.c)
@@ -14,11 +14,6 @@ Create the file CMakeLists.txt
cmake_minimum_required(VERSION 3.16)
project(hello)
-# Enable Objective C on Apple platforms, for ImageIO support
-if(APPLE)
- enable_language(OBJC)
-endif()
-
# set the output directory for built objects.
# This makes sure that the dynamic library goes into the build directory automatically.
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIGURATION>")
diff --git a/docs/INTRO-visualstudio.md b/docs/INTRO-visualstudio.md
index 946bacb4..9e6285f0 100644
--- a/docs/INTRO-visualstudio.md
+++ b/docs/INTRO-visualstudio.md
@@ -1,17 +1,18 @@
# Introduction to SDL_image with Visual Studio
-The easiest way to use SDL_image is to include it as a subproject in your project.
+The easiest way to use SDL_image is to include it along with SDL as subprojects in your project.
We'll start by creating a simple project to build and run [hello.c](hello.c)
- Create a new project in Visual Studio, using the C++ Empty Project template
- Add hello.c to the Source Files
-- Right click the solution, select add an existing project, navigate to SDL VisualC/SDL and add SDL.vcxproj
-- Right click the solution, select add an existing project, navigate to SDL_image VisualC and add SDL_image.vcxproj
-- Select your main project and go to Project -> Project Dependencies and select SDL3
-- Select your main project and go to Project -> Properties, set the filter at the top to "All Configurations" and "All Platforms", select VC++ Directories and add the SDL include directory to "Include Directories"
+- Right click the solution, select add an existing project, navigate to the SDL VisualC/SDL directory and add SDL.vcxproj
+- Right click the solution, select add an existing project, navigate to the SDL_image VisualC directory and add SDL_image.vcxproj
- Select your main project and go to Project -> Add Reference and select SDL3 and SDL3_image
+- Select your main project and go to Project -> Properties, set the filter at the top to "All Configurations" and "All Platforms", select VC++ Directories and add the SDL and SDL_image include directories to "Include Directories"
- Build and run!
-Support for AVIF, JPEG-XL, TIFF, and WebP are not included by default because of the size of the decode libraries, but you can get them by running external/download.sh, and then building the libraries and adding the appropriate LOAD_* preprocessor define to the SDL_image Visual Studio project.
+Support for AVIF, TIFF, and WebP are dynamically loaded at runtime. You can choose to include those DLLs and license files with your application if you want support for those formats, or omit them if they are not needed.
+
+Support for JPEG-XL is not included by default because of the size of the decode library, but you can get it by running external/Get-GitModules.ps1, and then building libjxl and adding the LOAD_JXL preprocessor define to the SDL_image Visual Studio project.
diff --git a/docs/INTRO-xcode.md b/docs/INTRO-xcode.md
index e8075bff..fab19368 100644
--- a/docs/INTRO-xcode.md
+++ b/docs/INTRO-xcode.md
@@ -1,7 +1,7 @@
# Introduction to SDL_image with Xcode
-The easiest way to use SDL_image is to include it as a subproject in your project.
+The easiest way to use SDL_image is to include it along with SDL as subprojects in your project.
We'll start by creating a simple project to build and run [hello.c](hello.c)
@@ -15,5 +15,5 @@ We'll start by creating a simple project to build and run [hello.c](hello.c)
- Select the project, select the main target, select the General tab, look for "Frameworks, Libaries, and Embedded Content", and add SDL3.framework and SDL3_image.framework
- Build and run!
-Support for AVIF, JPEG-XL, TIFF, and WebP are not included by default because of the size of the decode libraries, but you can get them by running external/download.sh and editing the config at the top of the Xcode project to enable them. You will need to include the appropriate framework in your application.
+Support for AVIF, JPEG-XL, and WebP are not included by default because of the size of the decode libraries, but you can get them by running external/download.sh and editing the config at the top of the Xcode project to enable them. You will need to include the appropriate framework in your application.