From d632c781c23bb02a4adabe970da02c64d9ca2008 Mon Sep 17 00:00:00 2001 From: xeruf Date: Sun, 7 Nov 2021 20:50:03 +0000 Subject: [PATCH] Suggest description --- doc/bugs/describe_what_git-annex_actually_is.mdwn | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 doc/bugs/describe_what_git-annex_actually_is.mdwn diff --git a/doc/bugs/describe_what_git-annex_actually_is.mdwn b/doc/bugs/describe_what_git-annex_actually_is.mdwn new file mode 100644 index 0000000000..237cf2584a --- /dev/null +++ b/doc/bugs/describe_what_git-annex_actually_is.mdwn @@ -0,0 +1,12 @@ +The homepage lists lots of things, but does not succinctly specify the core of git-annex. +It took me multiple sifts through the pages and a failed attempt at setting it up to discover that, and how it does not do what I currently need. + +> git-annex allows managing files with git, without checking the file contents into git. +> While that may seem paradoxical, it is useful when dealing with files larger than git can currently easily handle, whether due to limitations in memory, time, or disk space. + +The second sentence does not really help to explain the tool, for me it sounds a lot like git-lfs. My suggestion: + +> git-annex is a sparse file management tool that tracks files separately from their contents. +> It enables managing files larger than git can easily handle, whether due to limitations in memory, time, or disk space. + +Still not optimal, but feels a little more precise