Skip to content

Add template for git-annex data repo README #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add template for git-annex data repo README #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc5f4ca
Create template_git_repo_README.md
alexfoias Oct 28, 2021
9ed8ef9
Update git-annex.md
alexfoias Oct 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions git-annex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ git commit -m "Initial data"

If you are working on a private, internal dataset, continue by [uploading to `data.neuro.polymtl.ca`](./internal-server.md#new-repository).

Here is a [README](./template_git_repo_README.md) example.

## Troubleshooting

### version problems
Expand Down
8 changes: 8 additions & 0 deletions template_git_repo_README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
*NAME OF THE DATA REPO*
=======================

Dataset used for the project: *URL TO GH REPO*

Dataset description: e.g. This dataset is composed of T1w and T2w axial images of the cervical spinal cord.

This dataset was shared by *NAME AND EMAIL ADDRESS OF CONTRIBUITORS*, from *NAME OF THE UNIVERSITY THAT SHARED THE DATA*.