[Hamlib-commits] Hamlib -- Ham radio control libraries branch master updated. 8645a5a95e41dddeeefbf669d1009bbe105bb336

[n0nb <n0...@us...>]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Hamlib -- Ham radio control libraries".

The branch, master has been updated
       via  8645a5a95e41dddeeefbf669d1009bbe105bb336 (commit)
      from  f42782c2eac82d326783e5138a9bed860e9f83eb (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 8645a5a95e41dddeeefbf669d1009bbe105bb336
Author: Nate Bargmann <n0...@n0...>
Date:   Wed Sep 3 15:11:52 2025 -0500

    Add suggestions regarding Markdown

diff --git a/README.coding_style b/README.coding_style
index 7a3e2594e..661e7d62d 100644
--- a/README.coding_style
+++ b/README.coding_style
@@ -202,6 +202,24 @@ work flawlessly.  Somehow.
 When indenting a line in a Makefile.am (and the resulting Makefile) that a
 real Tab character (0x09) is required.  Spaces will cause 'make' errors.
 
+3.5 Markdown
+
+Markdown (https://daringfireball.net/projects/markdown/) is characterized by
+the use of various characters, indentation, and spaces to generate HTML markup
+by various tools.  There are several dialects of Markdown in use.  The most
+pertinent dialect for our use is GitHub Flavored Markdown
+(https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
+
+Besides its conversion to HTML, the intention of Markdown is readable text
+files where the formatting cues don't distract from reading the text.  Sites
+like GitHub will process these files on the fly and render them in HTML.
+
+For Markdown files included in Hamlib, consider these suggestions:
+
+ - Markdown files should have an extension of .md
+ - Spaces should be used instead of tabs.
+ - Text width should be limited to 80-100 characters with 80 preferred.
+
 
 4. Use of code formatting tools
 

-----------------------------------------------------------------------

Summary of changes:
 README.coding_style | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)


hooks/post-receive
-- 
Hamlib -- Ham radio control libraries