Skip to content

Commit

Permalink
Note about recursive clone and sub modules
Browse files Browse the repository at this point in the history
  • Loading branch information
SaschaWillems committed Jul 24, 2017
1 parent b5f1047 commit b8288cd
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ A comprehensive collection of open source C++ examples for [Vulkan(tm)](https://

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BHXPMV6ZKPH9E)

# Cloning

This repository contains submodules for some of the external dependencies, so when doing a fresh clone you need to clone recursively:

```
git clone --recursive https://github.com/SaschaWillems/Vulkan.git
```

Existing repositories can be updated manually:

```
git submodule init
git submodule update
```

# Building

The repository contains everything required to compile and build the examples on Windows, Linux and Android using a C++ compiler that supports C++11. All required dependencies are included.
Expand Down Expand Up @@ -41,10 +56,6 @@ Building for *iOS* and *macOS* is done using the [examples](xcode/examples.xcode

**Note:** Binary assets (textures, models) will no longer be added directly to the repository to keep it's size down, so newer examples will require the download of an [additional asset pack](data/README.md).

## Precompiled binaries

Precompiled binaries for Windows (x64), Linux (x64) and Android can be [found here](http://vulkan.gpuinfo.org/examples.php). Note that these may not always be up-to-date with the repository.

# Examples

*Examples marked with :speech_balloon: offer additional details with a separate readme.*
Expand Down

0 comments on commit b8288cd

Please sign in to comment.