From c884f01d8ec6e3b3d7fca84fb0575c8838ca429e Mon Sep 17 00:00:00 2001 From: "Steven R. Loomis" Date: Tue, 21 Aug 2018 10:53:14 -0700 Subject: [PATCH] Update README.md per #3181 - `git lfs install` does not actually install Git LFS. - `git lfs track` is not part of the installation steps, but part of example usage. - `install.sh` was not mentioned. Mention it. --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7810c163..4934b607 100644 --- a/README.md +++ b/README.md @@ -39,18 +39,30 @@ built from source using the latest version of [Go](https://golang.org), and the available instructions in our [Wiki](https://github.com/git-lfs/git-lfs/wiki/Installation#source). -### Usage +#### Installing from a [binary package](https://github.com/git-lfs/git-lfs/releases) -Git LFS requires a global installation once per-machine. This can be done by +The included script will install Git LFS binaries. It also runs `git lfs install` to +perform required global configuration changes. + +```bash +$ ./install.sh +``` + +#### Installing manually + +- Place the `git-lfs` binary on your system’s executable `PATH` or equivalent. +- Git LFS requires global configuration changes once per-machine. This can be done by running: ```bash $ git lfs install ``` -To begin using Git LFS within your Git repository, you can indicate which files -you would like Git LFS to manage. This can be done by running the following -_from within Git repository_: +## Example Usage + +To begin using Git LFS within a Git repository that is not already configured +for Git LFS, you can indicate which files you would like Git LFS to manage. +This can be done by running the following _from within Git repository_: ```bash $ git lfs track "*.psd"