Skip to content

Update README with git-lfs instructions #10

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

Open
santy-ttam wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README with git-lfs instructions #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ THIS IS A TEMPORARY WORKAROUND UNTIL A MORE PERMANENT STORAGE SOLUTION IS FOUND.

Run the following commands to create a directory called `examples` with all of the example and test files in it.
```
# Requires git-lfs
mkdir ldmat_tmp
cd ldmat_tmp
git init
Expand All @@ -20,6 +21,8 @@ git remote add origin https://github.com/G2Lab/ldmat.git
echo "examples/" > .git/info/sparse-checkout
git fetch --depth 1 origin
git pull origin main
git lfs install
git lfs pull
cd ..
mv ldmat_tmp/examples .
rm -rf ldmat_tmp
Expand Down Expand Up @@ -127,4 +130,4 @@ If you have a custom MAF format, implement `load_maf` as well.
Finally, make sure to give your loader a `FRIENDLY_NAME` so it can be referenced by the CLI.

If you think your input format is generic enough, or otherwise likely to be reused, feel free to submit
a pull request to add your loader to the package.
a pull request to add your loader to the package.