Skip to content

Commit bb551a8

Browse files
Updated the readme
1 parent 9b1b4a9 commit bb551a8

2 files changed

Lines changed: 9 additions & 2 deletions

File tree

README.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ CLI Usage is as follows::
7272
--milestones include milestones in backup
7373
--repositories include repository clone in backup
7474
--bare clone bare repositories
75-
--lfs clone LFS repositories
75+
--lfs clone LFS repositories (requires Git LFS to be installed, https://git-lfs.github.com)
7676
--wikis include wiki clone in backup
7777
--skip-existing skip project if a backup directory exists
7878
-L [LANGUAGES [LANGUAGES ...]], --languages [LANGUAGES [LANGUAGES ...]]
@@ -118,6 +118,13 @@ Note: When you run github-backup, you will be asked whether you want to allow "
118118
1. **Allow:** In this case you will need to click "Allow" each time you run `github-backup`
119119
2. **Always Allow:** In this case, you will not be asked for permission when you run `github-backup` in future. This is less secure, but is required if you want to schedule `github-backup` to run automatically
120120

121+
About Git LFS
122+
=============
123+
124+
When you use the "--lfs" option, you will need to make sure you have Git LFS installed.
125+
126+
Instructions on how to do this can be found on https://git-lfs.github.com.
127+
121128
Examples
122129
========
123130

bin/github-backup

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ def parse_args():
211211
parser.add_argument('--lfs',
212212
action='store_true',
213213
dest='lfs_clone',
214-
help='clone lfs repositories')
214+
help='clone LFS repositories (requires Git LFS to be installed, https://git-lfs.github.com)')
215215
parser.add_argument('--wikis',
216216
action='store_true',
217217
dest='include_wiki',

0 commit comments

Comments
 (0)