DiligentCore

(β˜… 751)

A modern cross-platform low-level graphics API

Showing a partial file list β€” download the zip above to see everything.

  • .clang-format
  • .gitignore
  • .gitmodules
  • .ignore
  • CMakeLists.txt
  • CODEOWNERS
  • Directory.Build.props
  • Directory.Packages.props
  • License.txt
  • README.md
  • ReleaseHistory.md

# Installation Guide

1. Get the code
git clone https://github.com/DiligentGraphics/DiligentCore

Downloads the entire project code from GitHub to your computer.

cd DiligentCore

Moves into the project folder you just downloaded.

2. CMake

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
cd BuildTools

This project's files live in a subfolder, so move into it first.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

3. .NET

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
python ./BuildTools/.NET/dotnet-build-package.py -c Debug -d ./

Runs the Python script (or module).

βœ… After dotnet run, check the message or address shown in the terminal.

Pulled directly from this repo's README.

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd BuildTools/Android

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
python -m pip install -r ./BuildTools/.NET/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd ThirdParty/glew

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation