Skip to content

Commit

Permalink
Updated INSTALL.md with simple intro breadcrumbs
Browse files Browse the repository at this point in the history
  • Loading branch information
slouken committed Jan 13, 2025
1 parent 77abf0e commit 8eaf073
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 39 deletions.
65 changes: 27 additions & 38 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,61 @@
# To compile and install SDL:

## Windows with Visual Studio:

Read [README-visualc.md](docs/README-visualc.md)
# To build and use SDL:

## Windows building with mingw-w64 for x86:
## Using CMake

Read [README-windows.md](docs/README-windows.md) for more information on building with MinGW64.
Read [BUILD-cmake.md](docs/BUILD-cmake.md) and [INTRO-cmake.md](docs/INTRO-cmake.md)

Run: `cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=build-scripts/cmake-toolchain-mingw64-i686.cmake && cmake --build build && cmake --install build`
## Using Visual Studio on Windows

## Windows building with mingw-w64 for x64:
Read [BUILD-visualstudio.md](docs/BUILD-visualstudio.md) and [INTRO-visualstudio.md](docs/INTRO-visualstudio.md)
# To compile and install SDL:

Read [README-windows.md](docs/README-windows.md).
## Using Xcode on Apple platforms

Run: `cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=build-scripts/cmake-toolchain-mingw64-x86_64.cmake && cmake --build build && cmake --install build`
Read [BUILD-xcode.md](docs/BUILD-xcode.md) and [INTRO-xcode.md](docs/INTRO-xcode.md)

## macOS with Xcode:
## Android:

Read [README-macos.md](docs/README-macos.md)
Read [BUILD-android.md](docs/BUILD-android.md) and [INTRO-android.md](docs/INTRO-android.md)

## macOS from the command line:
## Emscripten:

Run: `cmake -S . -B build && cmake --build build && cmake --install build`
Read [BUILD-emscripten.md](docs/BUILD-emscripten.md) and [INTRO-emscripten.md](docs/INTRO-emscripten.md)

### macOS for universal architecture:
## Other environments:

Run: `cmake -S . -B build -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64" && cmake --build build && cmake --install build`
SDL is also usable in other build environments. The basic steps are to use CMake to build the library and then use the headers and library that you built in your project. You can search online to see if anyone has specific steps for your environment.

## Linux and other UNIX systems:
# Documentation

Run: `cmake -S . -B build && cmake --build build --parallel $(nproc) && cmake --install build`
An API reference, tutorials, and additional documentation is available at:

## Android:
https://wiki.libsdl.org/SDL3

Read [README-android.md](docs/README-android.md)

## iOS:
# Example code

Read [README-ios.md](docs/README-ios.md)
There are simple example programs in the examples directory, and you can view them online at:

## Using CMake:
https://examples.libsdl.org/SDL3

Read [README-cmake.md](docs/README-cmake.md)
# Discussions

# Example code
## Discord

Look at the example programs in ./examples, and check out the online
documentation at https://wiki.libsdl.org/SDL3/
You can join the official Discord server at:

# Discussion
https://discord.com/invite/BwpFGBWsv8

## Forums/mailing lists

Join the SDL developer discussions, sign up on
You can join SDL development discussions at:

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.
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:
You can sign up for the low traffic announcement list at:

https://www.libsdl.org/mailing-list.php

5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ and emulators.
You can find the latest release and additional documentation at:
https://www.libsdl.org/

Installation instructions and a quick introduction is available in
[INSTALL.md](INSTALL.md)

This library is distributed under the terms of the zlib license,
available in the file LICENSE.txt.
available in [LICENSE.txt](LICENSE.txt).

Enjoy!

Expand Down

0 comments on commit 8eaf073

Please sign in to comment.