From 156e67a1b3a24d8c9f86aa6ea1be63953e83fb84 Mon Sep 17 00:00:00 2001
From: David Holdeman <david@chuckwagoncomputing.com>
Date: Fri, 14 Aug 2020 07:51:47 -0500
Subject: [PATCH] Add documentation to script (#1692)

---
 hardware/generate_diffs.sh | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/hardware/generate_diffs.sh b/hardware/generate_diffs.sh
index c41d23ede7..f68ec279e1 100644
--- a/hardware/generate_diffs.sh
+++ b/hardware/generate_diffs.sh
@@ -1,3 +1,13 @@
+#####################################################################################
+#                                 generate_diffs.sh                                 #
+#                                    08/13/2020                                     #
+#                             Written By David Holdeman                             #
+#   Checks for changed .kicad_pcb files, generates visual diffs, and uploads them   #
+#                                      to FTP.                                      #
+#####################################################################################
+# The FTP location this uploads to is /diffs/plot_<name of kicad_pcb file, without the extension>
+# In that directory are subdirectorys containing generated SVGs, as well as a 'web' subdirectory,
+# which contains index.html. Open that in a web browser and you get a nice visual diff of each layer.
 #!/bin/bash
 
 function gendiffs() {