Skip to content

Commit cb82e72

Browse files
authored
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
1 parent 8371175 commit cb82e72

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center"><img src="https://github.com/sigmf/SigMF/blob/v1.2.0/logo/sigmf_logo.svg" alt="Rendered SigMF Logo"/></p>
22

3-
# Signal Metadata Format (SigMF)
3+
# SigMF: The Signal Metadata Format
44

55
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.
66

docs-generator.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,15 @@ def gen_fields(doc, d):
8484
doc.append(NoEscape("\\fancyhf{}")) # clear all header/footer fields
8585
doc.append(NoEscape("\\renewcommand{\headrulewidth}{0pt}"))
8686
doc.append(NoEscape("\\fancyfoot[LE,RO]{\\thepage}"))
87-
doc.append(NoEscape("\\fancyfoot[LO,CE]{\\footnotesize Signal Metadata Format (SigMF) Specification Version " + sigmf_version + "}"))
87+
doc.append(NoEscape("\\fancyfoot[LO,CE]{\\footnotesize SigMF Specification Version " + sigmf_version + "}"))
8888

8989
with doc.create(Figure(position="h!")) as logo:
9090
doc.append(NoEscape("\\vspace{-0.8in}\\centering"))
9191
# doc.append(NoEscape('\\includesvg[width=200pt]{logo/sigmf\string_logo.svg}')) # Using SVG made PDF take a couple extra seconds to open...
9292
logo.add_image("logo/sigmf_logo.png", width="120px")
9393
doc.append(NoEscape("\\vspace{-0.3in}"))
9494

95-
with doc.create(Section("Signal Metadata Format (SigMF) Specification Version " + sigmf_version)):
95+
with doc.create(Section("SigMF Specification Version " + sigmf_version)):
9696
with doc.create(Subsection("Abstract")): # Abstract lives in the JSON Schema
9797
doc.append(data["description"])
9898

sigmf-schema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$id": "https://github.com/sigmf/SigMF/spec/1.2.0/sigmf-schema",
33
"$schema": "https://json-schema.org/draft/2020-12/schema",
44
"title": "Schema for SigMF Meta Files",
5-
"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.",
5+
"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.",
66
"type": "object",
77
"required": ["global", "captures", "annotations"],
88
"properties": {

0 commit comments

Comments
 (0)