Skip to content

Commit 2fa3b0d

Browse files
committed
home/secondary.html: clarify install and setup
We further clarify the documentation on the home page regarding how and when to install and configure LFS, distinguishing the normal one-time (per user) install step from the per-repository tracking setup steps, and also noting the "git lfs migrate" command and its use in dealing with pre-existing files. This builds on the clarifications added in PR #37 (commit 3eb274c).
1 parent 92c7f95 commit 2fa3b0d

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

_includes/home/secondary.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,17 @@ <h2 class="section-heading">Getting Started</h2>
2525
data-os-mac="https://github.com/git-lfs/git-lfs/releases/download/v{{site.git-lfs-release}}/git-lfs-darwin-amd64-v{{site.git-lfs-release}}.tar.gz"
2626
data-os-windows="https://github.com/git-lfs/git-lfs/releases/download/v{{site.git-lfs-release}}/git-lfs-windows-v{{site.git-lfs-release}}.exe"
2727
data-os-linux="https://github.com/git-lfs/git-lfs/releases/download/v{{site.git-lfs-release}}/git-lfs-linux-amd64-v{{site.git-lfs-release}}.tar.gz">Download</a>
28-
and install the Git command line extension. Once downloaded and installed, set up Git LFS and its respective hooks by running:
28+
and install the Git command line extension. Once downloaded and installed, set up Git LFS for your user account by running:
2929
</p>
3030
<pre>git lfs install</pre>
31-
<p>You'll need to run this in your repository directory, once per repository.</p>
31+
<p>You only need to run this once per user account.</p>
3232
</li>
3333
<li>
34-
<p>Select the file types you'd like Git LFS to manage (or directly edit your .gitattributes). You can configure additional file extensions at anytime.</p>
34+
<p>In each Git repository where you want to use Git LFS, select the file types you'd like Git LFS to manage (or directly edit your .gitattributes). You can configure additional file extensions at anytime.</p>
3535
<pre>git lfs track "*.psd"</pre>
36-
<p>Make sure .gitattributes is tracked</p>
36+
<p>Now make sure .gitattributes is tracked:</p>
3737
<pre>git add .gitattributes</pre>
38+
<p>Note that defining the file types Git LFS should track will not, by itself, convert any pre-existing files to Git LFS, such as files on other branches or in your prior commit history. To do that, use the <a href="https://github.com/git-lfs/git-lfs/blob/master/docs/man/git-lfs-migrate.1.ronn?utm_source=gitlfs_site&amp;utm_medium=doc_man_migrate_link&amp;utm_campaign=gitlfs">git lfs migrate[1]</a> command, which has a range of options designed to suit various potential use cases.</p>
3839
</li>
3940
<li>
4041
<p>There is no step three. Just commit and push to GitHub as you normally would.</p>

0 commit comments

Comments
 (0)