add build instructions and missing init flags

This commit is contained in:
risk danger olson 2015-10-20 11:39:01 -06:00
parent 3a673d662b
commit e77d5cc153
2 changed files with 30 additions and 2 deletions

@ -41,6 +41,28 @@ of transferring data.
You can see what the Git LFS team is prioritizing work on in the
[roadmap](./ROADMAP.md).
## Building
Git LFS depends on having a working Go 1.5+ environment, with your standard
`$GOROOT` and `$GOPATH` environment variables set. The easiest way to download
Git LFS for making changes is `go get`:
$ go get github.com/github/git-lfs
This clones the Git LFS repository to your `$GOPATH`. If you typically keep
your projects in a specific directory, you can symlink it from `$GOPATH`:
$ cd ~/path/to/your/projects
$ ln -s $GOPATH/src/github.com/github/git-lfs
From here, run `script/bootstrap` to build Git LFS in the `./bin` directory.
Before submitting changes, be sure to run the Go tests and the shell integration
tests:
$ script/test # runs just the Go tests
$ script/integration # runs the shell tests in ./test
$ script/cibuild # runs everything, with verbose debug output
## Submitting a pull request
0. [Fork][] and clone the repository

@ -3,8 +3,7 @@ git-lfs-init(1) -- Ensure Git LFS is configured properly
## SYNOPSIS
`git lfs init`<br>
`git lfs init` --force
`git lfs init` [options]
## DESCRIPTION
@ -22,6 +21,13 @@ filters if they are not already set.
* `--force`:
Sets the "lfs" smudge and clean filters, overwriting existing values.
* `--local`:
Sets the "lfs" smudge and clean filters in the local repository's git
config, instead of the global git config.
* `--skip-smudge`:
Skips automatic downloading of objects on clone or pull. This requires a
manual "git lfs pull" every time a new commit is checked out on your
repository.
## SEE ALSO