Skip to content

Commit

Permalink
Moving away from SigMF as an acronym (#316)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
777arc committed Jun 28, 2024
1 parent 8371175 commit cb82e72
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs-generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,15 @@ 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"))
# doc.append(NoEscape('\\includesvg[width=200pt]{logo/sigmf\string_logo.svg}')) # Using SVG made PDF take a couple extra seconds to open...
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"])

Expand Down
2 changes: 1 addition & 1 deletion sigmf-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down

0 comments on commit cb82e72

Please sign in to comment.