diff --git a/README.md b/README.md index ddd7573bf..5087cfd17 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,9 @@ Platforms : Windows, Mac - A release version can be downloaded from the [Releases](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases) page. - Alternatively: click the green `Code` button and then choose to download the zip archive. Remember, that you would download the branch that you are currently viewing in Github. +## Installing Git LFS + +This project uses Git Large Files Support (LFS), which ensures all large assets required locally are handled for the project. See [Git LFS installation options](https://github.com/git-lfs/git-lfs/wiki/Installation) for Windows and Mac instructions. ## Opening the project for the first time @@ -28,7 +31,6 @@ Once you have downloaded the project the steps below should get you up and runni ![](Documentation/Images/StartupScene.png) - From there you can click the **Play** button. You can host a new game or join an existing game using the in-game UI. - ## Testing multiplayer In order to see the multiplayer functionality in action we can either run multiple instances of the game locally on our computer or choose to connect to a friend over the internet. @@ -68,12 +70,8 @@ Code is organized into three separate assemblies: **Client**, **Shared** and **S For an in-depth overview of the project's architecture please check out our [ARCHITECTURE.md](ARCHITECTURE.md). - ## Contributing -> __IMPORTANT__: -> This project uses Git Large Files Support (LFS). See the [link with Git LFS installation options](https://git-lfs.github.com/). - The project uses the `git-flow` branching strategy, as such: - `develop` branch contains all active development - `master` branch contains release versions @@ -83,4 +81,7 @@ To get the project on your machine you need to clone the repository from GitHub git clone https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop.git ``` +> __IMPORTANT__: +> You should have [Git LFS](https://git-lfs.github.com/) installed on your local machine. + Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on submitting issues and PRs to BossRoom!