From 4508725547b325b2e7a1c4a0c2431aca74a8066e Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jean-Philippe=20Bruy=C3=A8re?= Date: Sun, 2 Feb 2020 17:31:48 +0100 Subject: [PATCH] update README: typo and broken links --- README.md | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index aad2315..bd7fb7b 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,15 @@
adaptation of the gltf PBR sample from Sacha Willems

-**vke.net** (_vulkan engine for .net_) is composed of high level classes encapsulating [vulkan]() objects and commands with `IDispose` model and **reference counting**. [GLFW](https://www.glfw.org/) handles the windowing system. +### Presentattion +**vke.net** (_vulkan engine for .net_) a vulkan abstraction layer writen in c# composed of high level classes encapsulating [vulkan](https://www.khronos.org/vulkan/) objects and commands with `IDispose` model and **reference counting**. [GLFW](https://www.glfw.org/) handles the windowing system. Vke use autogenerated [vk.net](https://github.com/jpbruyere/vk.net) library for low level binding to vulkan. Use the 'download_datas.sh' script for downloading sample's datas. +vke is in early development stage. + ### Requirements - [GLFW](https://www.glfw.org/) if you use the `VkWindow` class. - If you want to use `jpg`, `jpeg`, `png` image [libstb](https://github.com/nothings/stb) (on debian install **libstb-dev**). Note that `ktx` image loading has no dependencies. @@ -38,34 +41,33 @@ Use the 'download_datas.sh' script for downloading sample's datas. ### Quick Start -Create a new dotnet console project, and add the [vje nuget package](https://www.nuget.org/packages/vke) to it. +Create a new dotnet console project, and add the [vke nuget package](https://www.nuget.org/packages/vke) to it. ```xml - net472 - Exe - - - - + net472 + Exe + + + + ``` -For automatic shader compilation to SpirV, add also the [SpirVTasks nuget package](https://www.nuget.org/packages/SpirVTasks/0.1.41-beta). For documentation about this module, follow [this link](SpirVTasks/README.md). +For automatic shader compilation to SpirV, add also the [SpirVTasks](SpirVTasks/README.md) nuget package. ```xml - - - - - + + + + ``` ### Samples -| Title | Screen shots | -| :----------------------------------: | :------------------------------------------------: | -| [ClearScreen](ClearScreen/README.md) | ![screenshot](samples/screenShots/ClearScreen.png) | -| [Triangle](Triangle/README.md) | ![screenshot](samples/screenShots/Triangle.png) | -| [Textured](Textured/README.md) | ![screenshot](samples/screenShots/Textured.png) | +| Title | Screen shots | +| :------------------------------------------: | :------------------------------------------------: | +| [ClearScreen](samples/ClearScreen/README.md) | ![screenshot](samples/screenShots/ClearScreen.png) | +| [Triangle](samples/Triangle/README.md) | ![screenshot](samples/screenShots/Triangle.png) | +| [Textured](samples/Textured/README.md) | ![screenshot](samples/screenShots/Textured.png) | -- 2.47.3