ham-ref/hamlib
1
0
Fork 0
mirror of https://github.com/Hamlib/Hamlib synced 2026-08-13 17:32:05 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add suggestions regarding Markdown

Browse source
This commit is contained in:
Nate Bargmann 2025-09-03 15:11:52 -05:00
parent f42782c2ea
commit 8645a5a95e
No known key found for this signature in database
GPG key ID: FB2C5130D55A8819
1 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.coding_style
View file

@ -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