1datalad add-readme(1)       General Commands Manual      datalad add-readme(1)
2
3
4

NAME

6       datalad  add-readme - add basic information about DataLad datasets to a
7       README file
8

SYNOPSIS

10       datalad add-readme [-h] [-d DATASET] [--existing {skip|append|replace}]
11              [--version] [PATH]
12
13
14

DESCRIPTION

16       The  README  file  is added to the dataset and the addition is saved in
17       the dataset.  Note: Make sure that no  unsaved  modifications  to  your
18       dataset's
19

OPTIONS

21       PATH   Path  of  the README file within the dataset. Constraints: value
22              must be a string [Default: 'README.md']
23
24
25       -h, --help, --help-np
26              show this help message. --help-np forcefully disables the use of
27              a pager for displaying the help message
28
29       -d DATASET, --dataset DATASET
30              Dataset  to  add  information to. If no dataset is given, an at‐
31              tempt is made to identify the dataset based on the current work‐
32              ing  directory.  Constraints: Value must be a Dataset or a valid
33              identifier of a Dataset (e.g. a path) or value must be NONE
34
35       --existing {skip|append|replace}
36              How to react if a file with  the  target  name  already  exists:
37              'skip': do nothing; 'append': append information to the existing
38              file; 'replace': replace the existing  file  with  new  content.
39              Constraints:  value must be one of ('skip', 'append', 'replace')
40              [Default: 'skip']
41
42       --version
43              show the module and its version which provides the command
44

AUTHORS

46        datalad is developed by The DataLad Team and Contributors <team@datal‐
47       ad.org>.
48
49
50
51datalad add-readme 0.19.3         2023-08-11             datalad add-readme(1)