Skip to content

Commit

Permalink
Updated README.md and docu/README.md documents.
Browse files Browse the repository at this point in the history
  • Loading branch information
LukasBanana committed Aug 30, 2023
1 parent 0ea9cd5 commit a71d1d0
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ with Introduction, Hello Triangle Tutorial, and Extensibility Example with [GLFW
| <img src="docu/Icons/windows.svg" height="20" /> Windows | <p>[![MSVC16+ Build Status](https://github.com/LukasBanana/LLGL/actions/workflows/ci_windows.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_windows.yml)</p> <p>[![MSVC14 Build Status](https://ci.appveyor.com/api/projects/status/j09x8n07u3byfky0?svg=true)](https://ci.appveyor.com/project/LukasBanana/llgl)</p> | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | N/A |
| <img src="docu/Icons/linux.svg" height="20" /> GNU/Linux | [![GNU/Linux Build Status](https://github.com/LukasBanana/LLGL/actions/workflows/ci_linux.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_linux.yml) | N/A | N/A | :heavy_check_mark: | :heavy_check_mark: | N/A | N/A |
| <img src="docu/Icons/macos.svg" height="20" /> macOS | [![macOS Build Status](https://github.com/LukasBanana/LLGL/actions/workflows/ci_macos.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_macos.yml) | N/A | N/A | N/A | :heavy_check_mark: | N/A | :heavy_check_mark: |
| <img src="docu/Icons/ios.svg" height="20" /> iOS | [![iOS Build Status](https://github.com/LukasBanana/LLGL/actions/workflows/ci_ios.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_ios.yml) | N/A | N/A | N/A | N/A | :heavy_multiplication_x: | :heavy_check_mark: |
| <img src="docu/Icons/ios.svg" height="20" /> iOS | [![iOS Build Status](https://github.com/LukasBanana/LLGL/actions/workflows/ci_ios.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_ios.yml) | N/A | N/A | N/A | N/A | :heavy_check_mark: | :heavy_check_mark: |
| <img src="docu/Icons/android.svg" height="20" /> Android | | N/A | N/A | :heavy_multiplication_x: | N/A | :heavy_check_mark: | N/A |


Expand All @@ -39,16 +39,15 @@ Build scripts are provided for [**CMake**]((https://cmake.org/)).
### Windows

[**Visual Studio 2015**](https://visualstudio.microsoft.com/) or later is required to build LLGL on Windows.
The Windows SDK is also required to build D3D11 and D3D12 backends.

### macOS, iOS

[**Xcode 9**](https://developer.apple.com/xcode/) or later is required to build LLGL on macOS and iOS.

### GNU/Linux

The following development libraries are required to build LLGL on GNU/Linux:
- **X11**: `libx11-dev`
- **Xrandr**: `libxrandr-dev`
LLGL on GNU/Linux requires the development libraries for [X11](https://www.x.org/) and its [Xrandr](https://www.x.org/wiki/Projects/XRandR/) extension (see [docs](docu#gnulinux) for details).

### Android

Expand Down
7 changes: 6 additions & 1 deletion docu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ The primary build tool for LLGL is [CMake](https://cmake.org/) and while LLGL is

## Windows

LLGL is compatible with the MSVC toolchian of [Visual Studio](https://visualstudio.microsoft.com/) 2015 and later.
LLGL is compatible with the MSVC toolchain of [Visual Studio](https://visualstudio.microsoft.com/) 2015 and later.
To build D3D11 and D3D12 backends, the Windows SDK 10 (10.0.10240.0 or later) is also required.


## macOS
Expand All @@ -28,6 +29,10 @@ The `BuildLinux.sh` script recognizes several major Linux distributions.
Use `$ ./BuildLinux.sh -h` in a command prompt for more details.
See also `scripts/ListMissingPackages.sh` for details about supported OS distributions.

The following libraries are the minimum requirement to build LLGL on Linux:
- **X11**: `libx11-dev` (Debian), `libx11` (Arch), `libx11-devel` (RedHat)
- **Xrandr**: `libxrandr-dev` (Debian), `libxrandr` (Arch), `libXrandr-devel` (RedHat)


## MSYS2

Expand Down

0 comments on commit a71d1d0

Please sign in to comment.