diff --git a/README.md b/README.md index 2eb491357023adeef48ebaee8521131140d30552..207d11b24c5560327fb2e805651b7aae59788f15 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ If in doubt about your specific situation, please ask the research data manager - Compared with [JLUdata](https://jlupub.ub.uni-giessen.de/handle/jlupub/1), you can store data privately among the members of your project. JLUdata is the preferred choice to *publish* data (for example, you get a DOI). +- FIXME: Clarify that we talk about LFS on JLU GitLab, but that people can run their own LFS server with different settings/policies! ## Practical steps how to use Git LFS Assumptions: @@ -43,13 +44,14 @@ Assumptions: Below, example terminal commands are indicated with a different font and with a leading dollar sign, `$ like this`. - You have the Git LFS extension installed on your machine (you can find [instructions here](https://git-lfs.github.com/)). +Practical steps: 1. In your local repository clone, configure which types of files you want to track by LFS. - For example, to let LFS keep track of `CSV` files, type: `$ git lfs track "*.csv"`. - This will create/change the Git configuration file [`.gitattributes`](.gitattributes). You should track this configuration change in Git, e.g. by the usual Git commands `$ git add .gitattributes` and `$ git commit -m "start tracking HDF files with LFS"`. *Note that because the file name `.gitattributes` starts with a dot, it may be hidden from view (on Linux and MacOS, use `$ ls -a` to see it; FIXME: What to do on Windows?).* 2. FIXME: How to generally add files into LFS, and how to interact with them. -3. FIXME: Clarify the locking mechanism. +3. FIXME: Clarify locking mechanism, relevant for people working in teams, see https://github.com/git-lfs/git-lfs/wiki/File-Locking. ## Example(s)