Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a Gitter chat badge to README.md #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a Gitter chat badge to README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
Vulkan tutorial examples and demos
===============

[![Join the chat at https://gitter.im/heitaoflower/vulkan-tutorial](https://badges.gitter.im/heitaoflower/vulkan-tutorial.svg)](https://gitter.im/heitaoflower/vulkan-tutorial?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
## <img src="Docs/assets/windowslogo.png" alt="" height="32px"> 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