misc: Added a ToC to the top of HACKING.md

This commit is contained in:
dragonmux 2022-08-27 17:38:33 +01:00 committed by Piotr Esden-Tempski
parent 1f87ede6b6
commit 5525e05ea2
1 changed files with 6 additions and 0 deletions

View File

@ -1,5 +1,11 @@
# Information and terminology guide
Table of Contents:
* [Reset nomenclature](#reset-nomenclature)
* [Multiple-inclusion guarding](#multiple-inclusion-guarding)
* [typedef and structure, enumeration and union naming](#typedef-and-structure-enumeration-and-union-naming)
## Reset nomenclature
Within this code base, we refer to the physical reset pin of a target device by 'nRST'/'nRESET'.