-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/EvergineTeam/WebGPU.NET
# Conflicts: # README.md
- Loading branch information
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# WebGPU.NET | ||
|
||
## Introduction | ||
|
||
WebGPU.NET is a lightweight, low-level wrapper built on top of the `wgpu-native` library from Firefox. Our aim is to facilitate swift development of an adapter for Evergine, allowing for rapid testing across Windows, Linux, and Mac platforms using DirectX, Vulkan, and Metal. | ||
|
||
[![CI](https://github.com/EvergineTeam/WebGPU.NET/actions/workflows/CI.yml/badge.svg)](https://github.com/EvergineTeam/WebGPU.NET/actions/workflows/CI.yml) | ||
[![CD WebGPU](https://github.com/EvergineTeam/WebGPU.NET/actions/workflows/cd.yml/badge.svg)](https://github.com/EvergineTeam/WebGPU.NET/actions/workflows/cd.yml) | ||
[![Nuget](https://img.shields.io/nuget/v/Evergine.Bindings.WebGPU?logo=nuget)](https://www.nuget.org/packages/Evergine.Bindings.WebGPU) | ||
|
||
## Features | ||
|
||
- **Low-level Access**: Get closer to the metal with our streamlined API that wraps `wgpu-native`. | ||
|
||
- **Cross-Platform Support**: Test and deploy your applications seamlessly on Windows, Linux, and Mac. | ||
|
||
- **Multiple Graphics API Compatibility**: Designed with DirectX, Vulkan, and Metal in mind. | ||
|
||
## Prerequisites | ||
|
||
List any dependencies, required libraries, or external factors here. | ||
|
||
## Installation | ||
|
||
1. Clone the repository: `git clone https://github.com/EvergineTeam/WebGPU.NET.git` | ||
2. Navigate to the project directory. | ||
3. Run the HelloTriangle test project. | ||
|
||
### Usage | ||
|
||
To include `Evergine.Bindings.WebGPU` in your project, install the NuGet package: | ||
|
||
Install-Package Evergine.Bindings.WebGPU | ||
|
||
Or if you use the .NET CLI: | ||
|
||
dotnet add package Evergine.Bindings.WebGPU | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE.md](link_to_license.md) file for details. | ||
|
||
## Acknowledgments | ||
|
||
- Thanks to the Firefox team for the `wgpu-native` library. Check out the original library on [gfx-rs/wgpu-native](https://github.com/gfx-rs/wgpu-native). |