]> O.S.I.I.S - jp/vke.net.git/commitdiff
update README: typo and broken links
authorJean-Philippe Bruyère <jp_bruyere@hotmail.com>
Sun, 2 Feb 2020 16:31:48 +0000 (17:31 +0100)
committerJean-Philippe Bruyère <jp_bruyere@hotmail.com>
Sun, 2 Feb 2020 16:31:48 +0000 (17:31 +0100)
README.md

index aad23150b7b858d4188a1d6033dad63307d4f507..bd7fb7bbda2cebde5b663ed8a50ba60a8a247ac4 100644 (file)
--- a/README.md
+++ b/README.md
    <br>adaptation of the gltf PBR sample from Sacha Willems</br>
 </p>
 
-**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
 <Project Sdk="Microsoft.NET.Sdk">
-    <TargetFrameworks>net472</TargetFrameworks>
-    <OutputType>Exe</OutputType>
-    
-    <ItemGroup>
-           <PackageReference Include="vke" />
-    </ItemGroup>
+       <TargetFrameworks>net472</TargetFrameworks>
+       <OutputType>Exe</OutputType>
+
+       <ItemGroup>
+         <PackageReference Include="vke" />
+       </ItemGroup>
 </Project>
 ```
-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
-    <ItemGroup>    
-               <PackageReference Include="SpirVTasks" />
-        <GLSLShader Include="shaders\*.*" />           
-    </ItemGroup>
-
+       <ItemGroup>    
+       <PackageReference Include="SpirVTasks" />
+               <GLSLShader Include="shaders\*.*" />            
+       </ItemGroup>
 ```
 ### 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)   |