From 8f3ac13a6dcb89fefc0d95dc494e35ee847bf527 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20S=2E=20=C5=81ukasiewicz?= Date: Wed, 5 Nov 2025 17:42:43 +0100 Subject: [PATCH] Describe Git LFS in README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index c9289ca..2c4ca5a 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,13 @@ Named in this order so not everything starts with the same word. ## Development +The asset files like textures and models are very big, so the project also uses [Git Large File Storage](https://git-lfs.com/). +Once installed, it should work correctly with usual `git` commands but you may need to run this if you install it after cloning the repository: + +```sh +git lfs pull +``` + This repository uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), to get all the code you need to run either: ```sh