From cb82e72abf2de7793b370998944fab7188886de1 Mon Sep 17 00:00:00 2001
From: Marc Lichtman <marcll@vt.edu>
Date: Fri, 28 Jun 2024 03:54:22 -0400
Subject: [PATCH] Moving away from SigMF as an acronym (#316)

* Moving away from SigMF as an acronym

We (and others) use SigMF pretty directly, vs as an acronym for Signal Metadata Format, and there's really only a couple places the acronym still lives, including the readme title.

* Update sigmf-schema.json

* Update docs-generator.py
---
 README.md         | 2 +-
 docs-generator.py | 4 ++--
 sigmf-schema.json | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index a7a3f06..b544e7e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 <p align="center"><img src="https://github.com/sigmf/SigMF/blob/v1.2.0/logo/sigmf_logo.svg" alt="Rendered SigMF Logo"/></p>
 
-# Signal Metadata Format (SigMF)
+# SigMF: The Signal Metadata Format
 
 Welcome to the SigMF project! The [SigMF specifications can be viewed here](https://sigmf.github.io/SigMF/index.html) or [downloaded as a PDF](https://sigmf.github.io/SigMF/sigmf-spec.pdf). Below we discuss why and how you might use SigMF in your projects.
 
diff --git a/docs-generator.py b/docs-generator.py
index fc807e0..c5f2530 100644
--- a/docs-generator.py
+++ b/docs-generator.py
@@ -84,7 +84,7 @@ def gen_fields(doc, d):
 doc.append(NoEscape("\\fancyhf{}"))  # clear all header/footer fields
 doc.append(NoEscape("\\renewcommand{\headrulewidth}{0pt}"))
 doc.append(NoEscape("\\fancyfoot[LE,RO]{\\thepage}"))
-doc.append(NoEscape("\\fancyfoot[LO,CE]{\\footnotesize Signal Metadata Format (SigMF) Specification Version " + sigmf_version + "}"))
+doc.append(NoEscape("\\fancyfoot[LO,CE]{\\footnotesize SigMF Specification Version " + sigmf_version + "}"))
 
 with doc.create(Figure(position="h!")) as logo:
     doc.append(NoEscape("\\vspace{-0.8in}\\centering"))
@@ -92,7 +92,7 @@ def gen_fields(doc, d):
     logo.add_image("logo/sigmf_logo.png", width="120px")
     doc.append(NoEscape("\\vspace{-0.3in}"))
 
-with doc.create(Section("Signal Metadata Format (SigMF) Specification Version " + sigmf_version)):
+with doc.create(Section("SigMF Specification Version " + sigmf_version)):
     with doc.create(Subsection("Abstract")):  # Abstract lives in the JSON Schema
         doc.append(data["description"])
 
diff --git a/sigmf-schema.json b/sigmf-schema.json
index ad94d4a..86f451b 100644
--- a/sigmf-schema.json
+++ b/sigmf-schema.json
@@ -2,7 +2,7 @@
   "$id": "https://github.com/sigmf/SigMF/spec/1.2.0/sigmf-schema",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "Schema for SigMF Meta Files",
-  "description": "The Signal Metadata Format (SigMF) specifies a way to describe sets of recorded digital signal samples with metadata written in JSON. SigMF can be used to describe general information about a collection of samples, the characteristics of the system that generated the samples, features of signals themselves, and the relationship between different recordings.",
+  "description": "SigMF specifies a way to describe sets of recorded digital signal samples with metadata written in JSON. SigMF can be used to describe general information about a collection of samples, the characteristics of the system that generated the samples, features of signals themselves, and the relationship between different recordings.",
   "type": "object",
   "required": ["global", "captures", "annotations"],
   "properties": {