Man page - datalad-add-readme(1)
Packages contas this manual
- datalad-wtf(1)
- datalad-run(1)
- datalad-push(1)
- datalad-remove(1)
- datalad-update(1)
- datalad-create-test-dataset(1)
- datalad-sshrun(1)
- datalad-clean(1)
- datalad-clone(1)
- datalad-export-archive-ora(1)
- datalad-addurls(1)
- datalad-export-archive(1)
- datalad-check-dates(1)
- datalad(1)
- datalad-shell-completion(1)
- datalad-no-annex(1)
- datalad-create-sibling-gogs(1)
- datalad-create-sibling-gitlab(1)
- datalad-install(1)
- datalad-status(1)
- datalad-create-sibling(1)
- datalad-create-sibling-ria(1)
- datalad-add-readme(1)
- datalad-foreach-dataset(1)
- datalad-diff(1)
- datalad-subdatasets(1)
- datalad-rerun(1)
- datalad-create(1)
- datalad-export-to-figshare(1)
- datalad-copy-file(1)
- datalad-create-sibling-gitea(1)
- datalad-add-archive-content(1)
- datalad-siblings(1)
- datalad-drop(1)
- datalad-create-sibling-github(1)
- datalad-save(1)
- datalad-run-procedure(1)
- datalad-create-sibling-gin(1)
- datalad-download-url(1)
- datalad-unlock(1)
- datalad-get(1)
- datalad-uninstall(1)
- datalad-configuration(1)
- datalad-wtf(1)
- datalad-run(1)
- datalad-push(1)
- datalad-remove(1)
- datalad-update(1)
- datalad-create-test-dataset(1)
- datalad-sshrun(1)
- datalad-clean(1)
- datalad-clone(1)
- datalad-export-archive-ora(1)
- datalad-addurls(1)
- datalad-export-archive(1)
- datalad-check-dates(1)
- datalad(1)
- datalad-shell-completion(1)
- datalad-no-annex(1)
- datalad-create-sibling-gogs(1)
- datalad-create-sibling-gitlab(1)
- datalad-install(1)
- datalad-status(1)
- datalad-create-sibling(1)
- datalad-create-sibling-ria(1)
- datalad-add-readme(1)
- datalad-foreach-dataset(1)
- datalad-diff(1)
- datalad-subdatasets(1)
- datalad-rerun(1)
- datalad-create(1)
- datalad-export-to-figshare(1)
- datalad-copy-file(1)
- datalad-create-sibling-gitea(1)
- datalad-add-archive-content(1)
- datalad-siblings(1)
- datalad-drop(1)
- datalad-create-sibling-github(1)
- datalad-save(1)
- datalad-run-procedure(1)
- datalad-create-sibling-gin(1)
- datalad-download-url(1)
- datalad-unlock(1)
- datalad-get(1)
- datalad-uninstall(1)
- datalad-configuration(1)
Package: datalad
apt-get install datalad
apt-get install datalad
Manuals in package:
Documentations in package:
Package: datalad
apt-get install datalad
apt-get install datalad
Manuals in package:
Documentations in package:
Manual
| datalad add-readme(1) | General Commands Manual | datalad add-readme(1) |
NAME
datalad add-readme - add basic information about DataLad datasets to a README file
SYNOPSIS
datalad add-readme [-h] [-d DATASET] [--existing {skip|append|replace}] [--version] [PATH]
DESCRIPTION
The README file is added to the dataset and the addition is saved in the dataset. Note: Make sure that no unsaved modifications to your dataset's
OPTIONS
- PATH
- Path of the README file within the dataset. Constraints: value must be a string [Default: 'README.md']
- -h, --help, --help-np
- show this help message. --help-np forcefully disables the use of a pager for displaying the help message
- -d DATASET, --dataset DATASET
- 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) or value must be NONE
- --existing {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']
- --version
- show the module and its version which provides the command
AUTHORS
datalad is developed by The DataLad Team and Contributors <team@datalad.org>.
| 2025-06-15 | datalad add-readme 1.1.5 |