From aff8f9f35a1908d3ed73094da2f48288a44c35b0 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Wed, 17 Jul 2024 16:35:26 -0700 Subject: [PATCH] DOC: re-paste help text into repo readme. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6dfc4c64..6a8c5146 100644 --- a/README.md +++ b/README.md @@ -335,7 +335,12 @@ usage: ioc-deploy [-h] [--version] [--name NAME] [--release RELEASE]   ioc-deploy is a script for building and deploying ioc tags from github. It will create a shallow clone of your IOC in the standard release area at the -correct path and "make" it. +correct path and "make" it. If the tag directory already exists, the script +will exit. Example command: "ioc-deploy -n ioc-foo-bar -r R1.0.0" This will +clone the repository to the default ioc directory and run make using the +currently set EPICS environment variables. With default settings this will +clone from https://github.com/pcdshub/ioc-foo-bar to +/cds/group/pcds/epics/ioc/foo/bar/R1.0.0 then cd and make.   optional arguments:   -h, --help show this help message and exit