From ccc66fdee288f26972d1a501be9daac0b2f0d5f0 Mon Sep 17 00:00:00 2001 From: Lori Krell Date: Tue, 9 Mar 2021 14:57:21 -0600 Subject: [PATCH 1/3] update LFS info to be clear, easier to find --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 36e3995c3..2e9448fc4 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,16 @@ 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://git-lfs.github.com/). The following installation commands use Homebrew and Git: + +``` +brew install git-lfs +git lfs install +git pull #to be safe +git lfs status #to confirm +``` ## Opening the project for the first time @@ -28,7 +38,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 +77,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 +88,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! \ No newline at end of file From 400e73132654e6f1c6eb14705b5e346324849e78 Mon Sep 17 00:00:00 2001 From: Lori Krell <76010626+lkrell@users.noreply.github.com> Date: Mon, 15 Mar 2021 14:37:47 -0500 Subject: [PATCH 2/3] updated per review --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e9448fc4..c44a04d8d 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ Platforms : Windows, Mac ## 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://git-lfs.github.com/). The following installation commands use Homebrew and Git: +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://git-lfs.github.com/) for Windows and Mac instructions. + +The following Mac installation uses Homebrew and Git: ``` brew install git-lfs @@ -91,4 +93,4 @@ git clone https://github.com/Unity-Technologies/com.unity.multiplayer.samples.co > __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! \ No newline at end of file +Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on submitting issues and PRs to BossRoom! From 68c44e1dd9e59354cdab31ffafe2be5be56f3d24 Mon Sep 17 00:00:00 2001 From: Lori Krell <76010626+lkrell@users.noreply.github.com> Date: Mon, 15 Mar 2021 14:38:19 -0500 Subject: [PATCH 3/3] update link for instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c44a04d8d..afef65ad5 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Platforms : Windows, Mac ## 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://git-lfs.github.com/) for Windows and Mac instructions. +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. The following Mac installation uses Homebrew and Git: