From 5c4a66ba0d71c856212d22bbe0ea245a2eecfd13 Mon Sep 17 00:00:00 2001
From: Anonymous Maarten <[EMAIL REDACTED]>
Date: Tue, 25 Jul 2023 20:08:09 +0200
Subject: [PATCH] Add small README.md
---
README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 47 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b7ad6df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# setup-sdl
+
+This GitHub action downloads, builds and installs SDL from source.
+
+By caching the result, subsequent workflow runs will be fast(er).
+
+## Usage
+
+```yaml
+name: "sdl"
+on: [push]
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: libsdl-org/setup-sdl@main
+ id: sdl
+ with:
+ install-linux-dependencies: true
+ version: sdl2-latest
+
+ - name: 'Configure and build your project'
+ run: |
+ cmake -S . -B build
+ cmake --build build --verbose
+```
+
+## CMake
+
+This action will build SDL using the default c/c++ toolchain, with CMake configuring the build.
+
+An alternative build toolchain can be configured by using a [CMake toolchain file](https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html).
+
+## SDL versions
+
+Using the `version` option, a SDL release can be used or the latest git tag:
+- `sdl2-latest`: use the latest SDL2 release
+- `sdlx.y.z`: use exactly a SDL `x.y.z` release (example: `sdl2.8.1`)
+- `sdl2-head`: use the latest SDL2 development commit
+- `sdl3-latest`: use the latest SDL3 release
+- `sdl3-head`: use the latest SDL3 development commit
+- `<git hash>`: use an exact SDL git hash (repo: https://github.com/libsdl-org/SDL.git)
+
+## Options
+
+See [actions.yml] for an overview of all options, and its defaults.