Skip to content

Update Readme with working git-lfs instructions #212

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 2 commits into from
Nov 4, 2025
+5 −0
Merged

Update Readme with working git-lfs instructions #212

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d927e4d
Add instructions to readme.
JSOD11 Nov 1, 2025
abf2b65
Update comment following Gabriel's feedback.
JSOD11 Nov 4, 2025
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,15 @@ The integration tests also provide an idea about how to use the library and what
git lfs checkout
```

If the above does not work, try the following:
```bash
brew install git-lfs
Copy link
Collaborator

@gabotechs gabotechs Nov 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we can assume that people using this library are on MacOs, and these commands are irrelevant for Linux users.

What I'd do instead is to post a link that points to how to install git-lfs, ideally from an official source, and just let people follow that rather than putting the instruction for all the operating systems here.

Copy link
Contributor Author

@JSOD11 JSOD11 Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, updated. Thoughts?

git lfs install
git lfs pull
```

This step downloads Parquet files used in some tests. It must be completed successfully for the testing suite to pass.

### Running Tests

**Unit and integration tests:**
Expand Down