Add instructions for browsing using LFS cloning #223
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dpogue
reviewed
Feb 21, 2023
README.md
Outdated
| @@ -7,6 +7,9 @@ This repository is used to host assets used in Cyan World's Myst Online: Uru Liv | |||
| * [dirtsand](https://github.com/H-uru/dirtsand) - An open-source Plasma-compatible server project. | |||
| * [korman](https://github.com/H-uru/korman) - Blender plugin for creating ages for Cyan Worlds' Plasma engine. | |||
|
|
|||
| ## Browsing MOUL Assets | |||
| You may notice while browsing this repository online or after cloning on your own machine that most files seem to be small text files containing some kind of hash reference. This is because the MOUL assets repository is too large for (free) GitHub. We therefore use an external Git Large File Storage server. The easiest way to download the entire repository is to use `git lfs clone`. Do keep in mind that the repository is very large (over 20GB), so make sure to run this command in a location with sufficient space. You can of course also enable Git LFS be default. You can find some basic information on the [Git LFS website](https://git-lfs.com/) or refer to the [Git LFS wiki page on pulling and cloning](https://github.com/git-lfs/git-lfs/wiki/Tutorial#pulling-and-cloning). | |||
There was a problem hiding this comment.
You can of course also enable Git LFS be default.
This should say "by default", and we might also want to drop the "of course"
Deledrius
requested changes
Feb 21, 2023
|
According to the docs (and in my own testing), it appears that the |
Hoikas
added
documentation
Merged
Co-authored-by: Joseph Davies <deledrius@gmail.com>
Hoikas
approved these changes
Nov 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on #222 there was a need for this. Not sure if the "git lfs clone" is the best option, or if it would be better to just go for a "one time git lfs install", so feedback is very welcome!