.TH "datalad add-readme" "1" "2021\-02\-04" "datalad add-readme 0.14.0"
.SH NAME
\fBdatalad add-readme\fR \- add basic information about DataLad datasets to a README file
.SH SYNOPSIS
.nh
.HP
\fBdatalad add\-readme\fR [-h] [-d\~DATASET] [--existing\~{skip|append|replace}] [PATH]


.hy
.SH DESCRIPTION

The README file is added to the dataset and the addition is saved
in the dataset.
.SH OPTIONS
.TP
PATH
Path of the README file within the dataset. Constraints: value must be a string [Default: 'README.md']

.TP
\fB-h\fR, \fB--help\fR, \fB--help-np\fR
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
.TP
\fB-d\fR \fI\s-1DATASET\s0\fR, \fB--dataset\fR \fI\s-1DATASET\s0\fR
Dataset to add information to. If no dataset is given, an attempt is made to identify the dataset based on the current working directory. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path)
.TP
\fB--existing\fR {skip|append|replace}
How to react if a file with the target name already exists: 'skip': do nothing; 'append': append information to the existing file; 'replace': replace the existing file with new content. Constraints: value must be one of ('skip', 'append', 'replace') [Default: 'skip']
.SH AUTHORS
 datalad is developed by The DataLad Team and Contributors <team@datalad.org>.