From e32ef9fa9d88f5548908718899ec8057f9316057 Mon Sep 17 00:00:00 2001
From: Holger Frey <frey@imtek.de>
Date: Wed, 7 Oct 2020 11:13:44 +0200
Subject: [PATCH] added help text for sg_mbp_release

---
 work_helpers/sg_mbp_release.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/work_helpers/sg_mbp_release.py b/work_helpers/sg_mbp_release.py
index 0de5e70..10d8691 100644
--- a/work_helpers/sg_mbp_release.py
+++ b/work_helpers/sg_mbp_release.py
@@ -61,6 +61,17 @@ def copy_workbooks(destination, date, latest):
 
 @click.command()
 def cli():
+    """
+    Before running this command:
+
+    \b
+     - make the requiered edits to the workbooks
+     - edit the changelog in "E:\Safeguard-MBP-issues"
+     - create a new versions folder in "E:\Safeguard-MBP-issues", e.g. "v3.9.49"
+     - note the changes in the excel changelogs in the created version folder
+
+    The command will collect all data into one folder on the Desktop to be published
+    """
     latest = get_latest_version()
 
     new_folder_name = f"{TODAY} {latest}"