aboutsummaryrefslogtreecommitdiffstatsci
diff options
context:
space:
mode:
authorJean-Philippe Bruyère <jp_bruyere@hotmail.com>2019-08-29 03:19:45 +0200
committerJean-Philippe Bruyère <jp_bruyere@hotmail.com>2019-08-29 03:19:45 +0200
commitbbf4263cc3072ccf777acbcef242f895ff53f7bd (patch)
treea0565198db2a6a3a5ab4351d23223a650eb21c41
parentfaac99343a2c11711442f6ab5275b7983bd9370d (diff)
update readmes
-rw-r--r--README.md1
-rw-r--r--SpirVTasks/README.md16
2 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index 0e5d1fd..ca18dbd 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@
</a>
</p>
</h1>
+
# Vulkan net low-level bindings.
<a href="https://www.nuget.org/packages/Vulkan"><img src="https://buildstats.info/nuget/Vulkan"></a>
diff --git a/SpirVTasks/README.md b/SpirVTasks/README.md
index 1935054..e1278a3 100644
--- a/SpirVTasks/README.md
+++ b/SpirVTasks/README.md
@@ -11,32 +11,32 @@
</p>
</h1>
-SpirVTasks nuget package add SpirV compilation support to msbuild project. Resulting `.spv`
-files will be embedded with the resource ID = ProjectName.file.ext.spv.
+**SpirVTasks** package add **SpirV** compilation support to msbuild project. Error and warning
+are transmited to the **IDE**. Resulting `.spv` files will be embedded with the resource ID = ProjectName.file.ext.spv.
-Add glsl files to your project with the **`GLSLShader`** tag.
+Add glsl files to your project with the **`<GLSLShader>`** tag.
```xml
<ItemGroup>
- <GLSLShader Include="shaders\*.frag;shaders\*.vert;shaders\*.comp;shaders\*.geom" />
+ <GLSLShader Include="shaders\*.frag;shaders\*.vert;shaders\*.comp;shaders\*.geom" />
</ItemGroup>
```
The add-on will search for **glslc** executable with the **VULKAN_SDK** or **PATH** environments variables.
-You may also point to glslc with the **`SpirVglslcPath`** property (>= 0.1.7), but if the property is set.
+You may also point to glslc with the **`<SpirVglslcPath>`** property (>= 0.1.7), but if the property is set.
```xml
<PropertyGroup>
- <SpirVglslcPath>bin\glslc.exe</SpirVglslcPath>
+ <SpirVglslcPath>bin\glslc.exe</SpirVglslcPath>
</PropertyGroup>
```
I've added an **include** mechanism for glsl, file are searched from the location of the current parsed file,
-then in the **`SpirVAdditionalIncludeDirectories`** directories property.
+then in the **`<SpirVAdditionalIncludeDirectories>`** directories property.
```xml
<PropertyGroup>
- <SpirVAdditionalIncludeDirectories>$(MSBuildThisFileDirectory)common\shaders</SpirVAdditionalIncludeDirectories>
+ <SpirVAdditionalIncludeDirectories>$(MSBuildThisFileDirectory)common\</SpirVAdditionalIncludeDirectories>
</PropertyGroup>
```