Updated README to include use_git_lfs release option

bevyengine · Dec 17, 2023 · 216d5af · 216d5af
1 parent 8beddb7
commit 216d5af
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,8 @@ If you don't want to target some of those platforms, you can remove the correspo
 
 If you don't want to attach the builds to the GitHub release, set `env.add_binaries_to_github_release` to `false`.
 
+If you are using Git LFS, set `env.use_git_lfs` to `true` so your assets are properly checked out.
+
 ### Git Tag from GitHub UI
 
 You can follow [Managing releases in a repository](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)