Revise markdown formatting (#136)

Resolves #135 (Revise markdown formatting).

.github/ISSUE_TEMPLATE/bug.md

@@ -9,7 +9,7 @@ assignees: ''
 
 Please describe the bug that was encountered.
 Please provide as much detail as possible, covering things such as:
-- The `toolchain-avr-gcc` version (Git commit SHA)
+- The toolchain-avr-gcc version (Git commit SHA)
 - Description of expected behavior, and observed behavior
 - Relevant code and steps required to reproduce the bug
 - References to any relevant product pages, data sheets, application notes, and/or other

CONTRIBUTING.md

@@ -1,9 +1,11 @@
 # Contributing to toolchain-avr-gcc
-The following is a set of guidelines for contributing to `toolchain-avr-gcc`.
+
+The following is a set of guidelines for contributing to toolchain-avr-gcc.
 Note that these are guidelines, not rules.
 Use your best judgment.
 
 # Contents
+
 - [I have a question](#i-have-a-question)
 - [How can I contribute](#how-can-i-contribute)
     - [Report a bug](#report-a-bug)
@@ -18,6 +20,7 @@ Use your best judgment.
 - [Style-guide](#style-guide)
 
 # I have a question
+
 If you have a question, please review the relevant project documentation, and
 search/browse existing issues and discussions.
 If you have not found an answer to your question after reviewing the relevant project
@@ -27,10 +30,11 @@ discussion to ask your question.
 # How can I contribute
 
 ## Report a bug
+
 To report a bug, please use the `bug` issue template to open an issue that details the bug
 that was encountered.
 Please provide as much detail as possible, covering things such as:
-- The `toolchain-avr-gcc` version (Git commit SHA)
+- The toolchain-avr-gcc version (Git commit SHA)
 - Description of expected behavior, and observed behavior
 - Relevant code and steps required to reproduce the bug
 - References to any relevant product pages, data sheets, application notes, and/or other
@@ -40,6 +44,7 @@ If the bug report can be verified, the changes required to fix the bug will be c
 the issue in preparation for implementing the bug fix.
 
 ## Implement a bug fix
+
 Issues for implementing bug fixes can be found by looking for issues with the `type-bug`
 type label and `status-awaiting_development` status label.
 To implement a bug fix, please open a draft pull request that references the associated
@@ -50,6 +55,7 @@ If changes are requested, please discuss and/or address the review findings befo
 requesting a new review.
 
 ## Request an enhancement to an existing feature
+
 To request an enhancement to an existing feature, please use the `enhancement-request`
 issue template to open an issue that details the desired enhancement.
 Please provide as much detail as possible, covering things such as:
@@ -62,6 +68,7 @@ If the request for the enhancement to the existing feature is accepted, issue(s)
 designing or implementing the enhancement will be created as appropriate.
 
 ## Design an enhancement to an existing feature
+
 To design an enhancement to an existing feature, please use the `enhancement-design` issue
 template to open an issue that details the design.
 Please provide as much detail as possible, covering things such as:
@@ -76,6 +83,7 @@ If the design for the enhancement to the existing feature is accepted, issue(s)
 implementing the enhancement will be created.
 
 ## Implement an enhancement to an existing feature
+
 Issues for implementing enhancements to existing features can be found by looking for
 issues with the `type-enhancement` type label and `status-awaiting_development` status
 label.
@@ -87,6 +95,7 @@ If changes are requested, please discuss and/or address the review findings befo
 requesting a new review.
 
 ## Request a new feature
+
 To request a new feature, please use the `feature-request` issue template to open an issue
 that details the desired new feature.
 Please provide as much detail as possible, covering things such as:
@@ -99,6 +108,7 @@ If the request for the new feature is accepted, issue(s) for designing or implem
 feature will be created as appropriate.
 
 ## Design a new feature
+
 To design a new feature, please use the `feature-design` issue template to open an issue
 that details the design.
 Please provide as much detail as possible, covering things such as:
@@ -113,6 +123,7 @@ If the design for the new feature is accepted, issue(s) for implementing the fea
 be created.
 
 ## Implement a new feature
+
 Issues for implementing a new feature can be found by looking for issues with the
 `type-feature` type label and `status-awaiting_development` status label.
 To implement a new feature, please open a draft pull request that references the
@@ -123,6 +134,7 @@ If changes are requested, please discuss and/or address the review findings befo
 requesting a new review.
 
 ## Perform a refactoring
+
 Issues for performing a refactoring can be found by looking for issues with the
 `type-refactoring` type label and `status-awaiting_development` status label.
 To perform a refactoring, please open a draft pull request that references the associated
@@ -133,6 +145,7 @@ If changes are requested, please discuss and/or address the review findings befo
 requesting a new review.
 
 # Style guide
+
 Formatting for all source code and content is neither automated nor documented (with the
 exception of a column limit) at this time.
 Please use a column limit of 90 for source code and content.

README.md

@@ -1,13 +1,15 @@
 # toolchain-avr-gcc
+
 [![CI](https://github.com/apcountryman/toolchain-avr-gcc/actions/workflows/ci.yml/badge.svg)](https://github.com/apcountryman/toolchain-avr-gcc/actions/workflows/ci.yml)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
-`toolchain-avr-gcc` is a CMake toolchain for cross compiling for the Microchip AVR family
-of microcontrollers using avr-gcc.
+toolchain-avr-gcc is a CMake toolchain for cross compiling for the Microchip AVR family of
+microcontrollers using avr-gcc.
 In addition to configuring CMake for cross compiling with avr-gcc, the toolchain provides
 optional avrdude utilities.
 
 ## Obtaining the Source Code
+
 HTTPS:
 ```shell
 git clone https://github.com/apcountryman/toolchain-avr-gcc.git
@@ -18,6 +20,7 @@ git clone [email protected]:apcountryman/toolchain-avr-gcc.git
 ```
 
 ## Usage (Dependency)
+
 To use this toolchain, simply set `CMAKE_TOOLCHAIN_FILE` to the path to this repository's
 `toolchain.cmake` file when initializing CMake.
 
@@ -33,13 +36,15 @@ Documentation for the usage of the avrdude utilities [can be found in the
 `avrdude-utilities.cmake` file in this repository](avrdude-utilities.cmake).
 
 ### Finding Tools
+
 This toolchain expects to find `avr-gcc`, `avr-g++`, associated binary utilities, and
 `avrdude` in the path(s) searched by CMake's `find_program()` command.
 `avrdude` is only required if `avrdude-utilities.cmake` is included.
 If the toolchain fails to locate tools, consult the documentation for CMake's
 `find_program()` command.
 
 ## Usage (Development)
+
 This repository's Git `pre-commit` hook script is the simplest way to configure, build,
 and test this project during development.
 See the `pre-commit` script's help text for usage details.
@@ -51,33 +56,40 @@ Additional checks, such as static analysis, are performed by this project's GitH
 CI workflow.
 
 ## Versioning
-Post version 0.3.0, `toolchain-avr-gcc` will follow the [Abseil Live at Head
+
+Post version 0.3.0, toolchain-avr-gcc will follow the [Abseil Live at Head
 philosophy](https://abseil.io/about/philosophy).
 
 ## Workflow
-`toolchain-avr-gcc` uses the [GitHub flow](https://guides.github.com/introduction/flow/)
+
+toolchain-avr-gcc uses the [GitHub flow](https://guides.github.com/introduction/flow/)
 workflow.
 
 ## Git Hooks
+
 To install this repository's Git hooks, run the `install` script located in the
 `git/hooks` directory.
-See the script's help text for usage details.
+See the `install` script's help text for usage details.
 ```
 $ ./git/hooks/install --help
 ```
 
 ## Code of Conduct
-`toolchain-avr-gcc` has adopted the Contributor Covenant 2.0 code of conduct.
+
+toolchain-avr-gcc has adopted the Contributor Covenant 2.0 code of conduct.
 For more information, [see the `CODE_OF_CONDUCT.md` file in this
 repository](CODE_OF_CONDUCT.md).
 
 ## Contributing
-If you are interested in contributing to `toolchain-avr-gcc`, please [read the
+
+If you are interested in contributing to toolchain-avr-gcc, please [read the
 `CONTRIBUTING.md` file in this repository](CONTRIBUTING.md).
 
 ## Authors
+
 - Andrew Countryman
 
 ## License
-`toolchain-avr-gcc` is licensed under the Apache License, Version 2.0.
-For more information, [see the LICENSE file in this repository](LICENSE).
+
+toolchain-avr-gcc is licensed under the Apache License, Version 2.0.
+For more information, [see the `LICENSE` file in this repository](LICENSE).