Skip to content

Update LFS content in README #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 18, 2021
Merged

Update LFS content in README #151

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ccc66fd
update LFS info to be clear, easier to find
lkrell Mar 9, 2021
400e731
updated per review
lkrell Mar 15, 2021
68c44e1
update link for instructions
lkrell Mar 15, 2021
0cc78a9
Merge branch 'release/v0.1.0-experimental' into mttdoc113-lfs-content
lkrell Mar 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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!