From 6b55c0579cadf2a608b187b1448e646fae4067b0 Mon Sep 17 00:00:00 2001
From: Lucas Wilson-Richter <lucas@buildkite.com>
Date: Wed, 15 May 2024 17:42:45 +1000
Subject: [PATCH] Descriptive comments for fcl

---
 fcl | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/fcl b/fcl
index 1305d10..c6cddfc 100755
--- a/fcl
+++ b/fcl
@@ -1,5 +1,20 @@
 #!/usr/bin/env ruby
 
+## fcl: Fantastic CLoner
+#
+# Clones git repos into a predictable directory structure, according to local
+# customs (HTTPS instead of SSH for Buildkite repos, for example)
+#
+# Makes educated guesses about incomplete repo identifiers.
+#
+# Also with some CLI pretty thanks to `gum`.
+#
+
+# TODO LIST
+#
+# [ ] Make a way to turn off the pretty, in case it's getting in the way
+#
+
 DEFAULT_ORG = "buildkite"
 REPO_BASE   = "#{ENV['HOME']}/repos"