Skip to content
This repository has been archived by the owner on Apr 8, 2024. It is now read-only.

Commit

Permalink
Small updates to readme and build instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
pigmej committed Dec 12, 2022
1 parent 4669c3d commit e7fbbb5
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ A c library implementing the POST API setup method for general-purpose CPUs and

## Runtime System Requirements

Windows 10, macOS or Ubuntu.
Windows 10/11, macOS or Ubuntu.
One or more of the following processors:

- A GPU and drivers with CUDA support (minimum compute compatibility 5.0, maximum compute compatibility 8.6), such as a modern Nvidia GPU and Nvidia drivers version R450 or newer.
- A GPU and drivers with CUDA support (minimum compute compatibility 5.0, maximum compute compatibility 9), such as a modern Nvidia GPU and Nvidia drivers version R525 or newer.
- A GPU and drivers with Vulkan 1.3 support such as a modern AMD, Apple M1 processor, and Intel GPUs.
- A x86-64 cpu such as AMD or Intel CPUs.
- Both discrete and on-board GPUs are supported as long as they support the minimum CUDA or Vulkan runtime version.
Expand All @@ -28,31 +28,35 @@ One or more of the following processors:

- 2080 MiB

### Runtime linux requirements

On Linux platforms with hybrid Nvidia GPU setup please use Nvidia driver R525 or newer. Older ones are known to have compatibility issues. Non hybrid cards are confirmed to be working with R520 and older versions.

---

## Build System Requirements

### All Platforms

- For building CUDA support: NVIDIA Cuda Toolkit 11, an NVIDIA GPU with CUDA support, and an Nvdia driver version R450 or newer.
- For building CUDA support: NVIDIA Cuda Toolkit 11, an NVIDIA GPU with CUDA support, and an Nvdia driver version R525 or newer.
- For building Vulkan support: Vulkan SDK 1.3 and a GPU with Vulkan 1.3 runtime support.

### Windows

- Windows 10 Pro.
- Windows 10/11 Pro.
- Microsoft Visual Studio 2022
- You may also need to install specific versions of the Windows SDK when prompted when attempting to build the library for the first time.

### Ubuntu

- Ubuntu 22.04
- Cmake, GCC 7
- Cmake, GCC 11+

### macOS

- Xcode
- Xcode Command Line Dev Tools
- Cmake, GCC 7
- Cmake, GCC 11+

### macOS Dev Env Setup

Expand Down Expand Up @@ -100,7 +104,7 @@ To build the library with full support for both CUDA and Vulkan on Windows or on

### Building on Windows

1. Open project folder into Visual Studio 2017: `File -> Open -> Folder`.
1. Open project folder into Visual Studio 2022: `File -> Open -> Folder`.
2. Set `x64-Release` Project Settings.
3. Build: `CMake -> Rebuild All`.
4. Run test: `CMake -> Debug from Build Folder -> gpu-setup-test.exe`
Expand Down

0 comments on commit e7fbbb5

Please sign in to comment.