Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
peeweek committed Mar 2, 2020
1 parent c55cc1e commit 19c49eb
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@

Spaceship Demo is a AAA Playable First person demo showcasing effects made with Visual Effect Graph and rendered with High Definition Render Pipeline.

For update information, see the [changelog](https://github.com/Unity-Technologies/SpaceshipDemo/blob/master/CHANGELOG.md).
**[DOWNLOAD LATEST RELEASE HERE](https://github.com/Unity-Technologies/SpaceshipDemo/releases/latest)**

For update information, see the [Changelog](https://github.com/Unity-Technologies/SpaceshipDemo/blob/master/CHANGELOG.md).

## Requirements

In order to download and run the latest Spaceship demo project, make sure you have the following
* [Github Desktop](https://desktop.github.com/) or [Git For Windows](https://git-scm.com/download/win) + [Git LFS](https://git-lfs.github.com/) (Required for Cloning the Repository) or any other git client.
* Unity 2019.3.0f6 or newer (See each release notes in [changelog](https://github.com/Unity-Technologies/SpaceshipDemo/blob/master/CHANGELOG.md) for version requirements)
* Unity 2019.3.2f1 or newer (See each release notes in [changelog](https://github.com/Unity-Technologies/SpaceshipDemo/blob/master/CHANGELOG.md) for version requirements)

## How to Download/Install

### Method 1 : Clone the repository

**Important Note**: This repository uses **Git-LFS** to store large files. In order to get the data correctly you need to [install Git-LFS](https://git-lfs.github.com/) before starting to clone the repository.
**Important Note**: This repository uses **Git-LFS** to store large files. In order to get the data correctly you need to [install Git-LFS](https://git-lfs.github.com/) before starting to clone the repository. **Do NOT use the Download ZIP button as it will not get the LFS files correctly**

#### Using Github Desktop

Expand All @@ -30,5 +32,4 @@ You can clone this repository and start opening directly the project using the f

You can also download project archives in the [Releases](https://github.com/Unity-Technologies/SpaceshipDemo/releases) tab. These zip files contains the full project for a one-time download without Git.

**Important Note** : As GitHub does not generate correct archives with LFS files, In order to download the correct project with largefiles, **you need to download the file linked in the release description** instead of the automatically generated Source Code zip and tar.gz files.

**Important Note** : As GitHub does not generate correct archives with LFS files, In order to download the correct project with largefiles, **you need to download the file linked in the release description** instead of the automatically generated Source Code zip and tar.gz files.

0 comments on commit 19c49eb

Please sign in to comment.