From 402238b2725c24d37867523f1f06c0f039ee0b88 Mon Sep 17 00:00:00 2001 From: User Date: Wed, 13 Oct 2021 02:34:23 -0400 Subject: [PATCH] README.md: Re-generate --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 886b7b5..04163f5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 1. [Introduction](#introduction) 2. [Doxygen comments](#doxygen-comments) 3. [Installation](#installation) - 4. [Setup / Starting](#setup-starting) + 4. [Setup / Starting](#setup--starting) 5. [Roadmap](#roadmap) 6. [Release History](#release-history) 7. [Related Tools](#related-tools) @@ -50,7 +50,7 @@ In order for any of this to work, you MUST comment your functions using Doxygen - The blank line above the comment block is required for this package. - - The double comment symbol `##` is also required by this package (and also by `bash-doxygen` if you use that (see [Related Tools](#related-tools))). + - The double comment symbol (`##`) is also required by this package (and also by `bash-doxygen` if you use that (see [Related Tools](#related-tools))). ## Installation @@ -110,7 +110,7 @@ There are a few things I do have some ideas – but not time, currently &#x - **2021-10-12 - v0.1.0** - I just barely got this initally working and quickly wrote a README and packaged it up for quick release. It "works for me" but I currently consider it alpha software. See also [Roadmap](#roadmap). -## Related Tools +### Footnotested Tools - [bash-doxygen](https://github.com/Anvil/bash-doxygen) - A basic doxygen filter (originally written in GNU sed) allowing you to add inline-documentation to your bash shell scripts. - You will actually need this in addition to Doxygen itself in order for Doxygen to be able to generate all the nice docs automatically. -- 2.38.5