diff --git a/README.md b/README.md index 64505bf..1432c80 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,24 @@ Vulkan tutorial examples and demos =============== + +[![Join the chat at https://gitter.im/heitaoflower/Lobby](https://badges.gitter.im/heitaoflower/Lobby.svg)](https://gitter.im/heitaoflower/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ![vulkan_logo](Docs/assets/vulkanlogo.png) -The first part of the tutorial involves the use of vulkan to draw basic triangles every step. Each setp has its own subdirectory containing a complete copy of the tutorial for that setp +The first part of the tutorial involves the use of vulkan to draw basic triangles every step. Each setp has its own subdirectory containing a complete copy of the tutorial for that setp. + +# Prerequisites +| | Windows | Android | MacOS/iOS | +|:---:|:---:|:---:|:---:| +|CI Status|[![Build status](https://ci.appveyor.com/api/projects/status/994t283721pa8fo8/branch/master?svg=true)](https://ci.appveyor.com/project/heitaoflower/vulkan-tutorial/branch/master)|TODO |TODO| +|IDE| Visual Studio 2017 | Android Studio 2.2+| Xcode 8.1+ | +|OS Requirements| Win8.1 | Android 7.+| MacOS Sierra | +|Dependency| [ThirdParty](https://github.com/heitaoflower/vulkan-tutorial-3rdparty) | TODO | TODO | -## Building -The repository contains everything required to compile and build the examples on Windows. +# Build Instructions ## Windows -A Visual Studio solution file for compiling all examples is included with the repository, examples will compile with VS2017 and WindowsSDK10.0.x. +A Visual Studio solution file for compiling all example projects is included with the repository, examples will compile with Visual Studio 2017 and WindowsSDK10.0.x. + +The repository contains everything required to compile and build the example projects on Windows. -If you're using a difference IDE or compiler you can use the provided CMakeLists.txt for use with [CMake](https://cmake.org/) to generate a build configuration for your toolchain. -### Requirements +## Requirements * VulkanSDK : 1.0.46.0