Skip to content

Commit 55e094f

Browse files
committed
Updated INSTALL.md with simple intro breadcrumbs
1 parent 584c1d5 commit 55e094f

File tree

2 files changed

+30
-39
lines changed

2 files changed

+30
-39
lines changed

INSTALL.md

Lines changed: 26 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,60 @@
1-
# To compile and install SDL:
1+
# To build and use SDL:
22

3-
## Windows with Visual Studio:
3+
## Using CMake
44

5-
Read [README-visualc.md](docs/README-visualc.md)
5+
Read [BUILD-cmake.md](docs/BUILD-cmake.md) and [INTRO-cmake.md](docs/INTRO-cmake.md)
66

7-
## Windows building with mingw-w64 for x86:
7+
## Using Visual Studio on Windows
88

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

11-
Run: `cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=build-scripts/cmake-toolchain-mingw64-i686.cmake && cmake --build build && cmake --install build`
11+
## Using Xcode on Apple platforms
1212

13-
## Windows building with mingw-w64 for x64:
13+
Read [BUILD-xcode.md](docs/BUILD-xcode.md) and [INTRO-xcode.md](docs/INTRO-xcode.md)
1414

15-
Read [README-windows.md](docs/README-windows.md).
16-
17-
Run: `cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=build-scripts/cmake-toolchain-mingw64-x86_64.cmake && cmake --build build && cmake --install build`
18-
19-
## macOS with Xcode:
20-
21-
Read [README-macos.md](docs/README-macos.md)
15+
## Android:
2216

23-
## macOS from the command line:
17+
Read [BUILD-android.md](docs/BUILD-android.md) and [INTRO-android.md](docs/INTRO-android.md)
2418

25-
Run: `cmake -S . -B build && cmake --build build && cmake --install build`
19+
## Emscripten:
2620

27-
### macOS for universal architecture:
21+
Read [BUILD-emscripten.md](docs/BUILD-emscripten.md) and [INTRO-emscripten.md](docs/INTRO-emscripten.md)
2822

29-
Run: `cmake -S . -B build -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64" && cmake --build build && cmake --install build`
23+
## Other environments:
3024

31-
## Linux and other UNIX systems:
25+
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.
3226

33-
Run: `cmake -S . -B build && cmake --build build --parallel $(nproc) && cmake --install build`
27+
# Documentation
3428

35-
## Android:
29+
An API reference, tutorials, and additional documentation is available at:
3630

37-
Read [README-android.md](docs/README-android.md)
31+
https://wiki.libsdl.org/SDL3
3832

39-
## iOS:
33+
# Example code
4034

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

43-
## Using CMake:
37+
https://examples.libsdl.org/SDL3
4438

45-
Read [README-cmake.md](docs/README-cmake.md)
39+
# Discussions
4640

47-
# Example code
41+
## Discord
4842

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

52-
# Discussion
45+
https://discord.com/invite/BwpFGBWsv8
5346

5447
## Forums/mailing lists
5548

56-
Join the SDL developer discussions, sign up on
49+
You can join SDL development discussions at:
5750

5851
https://discourse.libsdl.org/
5952

60-
and go to the development forum
61-
62-
https://discourse.libsdl.org/c/sdl-development/6
63-
64-
Once you sign up, you can use the forum through the website, or as a mailing
65-
list from your email client.
53+
Once you sign up, you can use the forum through the website or as a mailing list from your email client.
6654

6755
## Announcement list
6856

69-
Sign up for the announcement list through the web interface:
57+
You can sign up for the low traffic announcement list at:
7058

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

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ and emulators.
66
You can find the latest release and additional documentation at:
77
https://www.libsdl.org/
88

9+
Installation instructions and a quick introduction is available in
10+
[INSTALL.md](INSTALL.md)
11+
912
This library is distributed under the terms of the zlib license,
10-
available in the file LICENSE.txt.
13+
available in [LICENSE.txt](LICENSE.txt).
1114

1215
Enjoy!
1316

0 commit comments

Comments
 (0)