Skip to content

Commit f0dd033

Browse files
authored
Update LFS content in README (#151)
1 parent 592f9e2 commit f0dd033

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ Platforms : Windows, Mac
1616
- A release version can be downloaded from the [Releases](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases) page.
1717
- 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.
1818

19+
## Installing Git LFS
20+
21+
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.
1922

2023
## Opening the project for the first time
2124

@@ -28,7 +31,6 @@ Once you have downloaded the project the steps below should get you up and runni
2831
![](Documentation/Images/StartupScene.png)
2932
- From there you can click the **Play** button. You can host a new game or join an existing game using the in-game UI.
3033

31-
3234
## Testing multiplayer
3335

3436
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
6870

6971
For an in-depth overview of the project's architecture please check out our [ARCHITECTURE.md](ARCHITECTURE.md).
7072

71-
7273
## Contributing
7374

74-
> __IMPORTANT__:
75-
> This project uses Git Large Files Support (LFS). See the [link with Git LFS installation options](https://git-lfs.github.com/).
76-
7775
The project uses the `git-flow` branching strategy, as such:
7876
- `develop` branch contains all active development
7977
- `master` branch contains release versions
@@ -83,4 +81,7 @@ To get the project on your machine you need to clone the repository from GitHub
8381
git clone https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop.git
8482
```
8583

84+
> __IMPORTANT__:
85+
> You should have [Git LFS](https://git-lfs.github.com/) installed on your local machine.
86+
8687
Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on submitting issues and PRs to BossRoom!

0 commit comments

Comments
 (0)