Commit 2baa9b5e authored by Nick Bearson's avatar Nick Bearson
Browse files

fleshing this out with some best practices

parent bcaf83bf
This repository requires [git-lfs](https://git-lfs.github.com/) support.
# On Clones, Fetches, and Pulls
It's recommended that you run `scripts/verify_checksums.sh` from the base directory. This will check `checksums` against all of the files in `data/`.
# When Making Changes
You can modify files and use git commands just like you would with regular files. Text files (like `*.instrument`) are tracked just like any other text file in git. Binary files are tracked with git-lfs.
When you commit changes, it's recommended that you run `scripts/generate_checksums.sh` and `git add checksums` so that the checksums file stays up to date.
# To Add a Binary File With a New Extension
From the project's base directory:
```bash
git lfs track '*.ext'
scripts/generate_checksums.sh
git add data/my/file.ext checksums
git commit
```
See `.gitattributes` for the full list of file extensions currently being tracked by git-lfs.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment