From 8645a5a95e41dddeeefbf669d1009bbe105bb336 Mon Sep 17 00:00:00 2001 From: Nate Bargmann Date: Wed, 3 Sep 2025 15:11:52 -0500 Subject: [PATCH] Add suggestions regarding Markdown --- README.coding_style | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) 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