From 3b3041139ceb28e6be80d7c530fb22f8a3f6a876 Mon Sep 17 00:00:00 2001
From: Joshua Potter <jrpotter2112@gmail.com>
Date: Sun, 26 Nov 2023 14:54:42 -0700
Subject: [PATCH] Cleanup `README.md`.

---
 specs/clang/template/README.md | 27 +++++++++------------------
 1 file changed, 9 insertions(+), 18 deletions(-)

diff --git a/specs/clang/template/README.md b/specs/clang/template/README.md
index 982ec62..8f274b1 100644
--- a/specs/clang/template/README.md
+++ b/specs/clang/template/README.md
@@ -1,10 +1,9 @@
 # Clang Flake Template
 
 This is a template for constructing a working environment for C development with
-the [clang](https://clang.llvm.org/) (version 16.0.6) toolchain.
-
-[direnv](https://direnv.net/) can be used to launch a dev shell upon entering
-this directory (refer to `.envrc`). Otherwise, run via:
+the [clang](https://clang.llvm.org/) (version 16.0.6) toolchain. [direnv](https://direnv.net/)
+can be used to launch a dev shell upon entering this directory (refer to
+`.envrc`). Otherwise run via:
 ```bash
 nix develop
 ```
@@ -15,9 +14,7 @@ The [clangd](https://clangd.llvm.org/) LSP (version 14.0.6) is included in this
 flake. The [codelldb](https://github.com/vadimcn/codelldb) VSCode plugin is also
 included to interface with the LSP. Note this plugin, despite its name, is
 compatible with other editors (e.g. neovim). To configure, refer to your
-editor's documentation.
-
-To use the LSP across files, a [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html)
+editor's documentation. To use the LSP across files, a [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html)
 must be generated. For this reason, [bear](https://github.com/rizsotto/Bear)
 (version 3.1.3) is included in this flake. Use as follows to generate a
 `compile_commands.json` file:
@@ -28,11 +25,8 @@ $> bear -- <your-build-command>
 ## Documentation
 
 Documentation is generated using [Doxygen](https://www.doxygen.nl/index.html)
-(version 1.9.7). The included Doxyfile was generated by running:
-```bash
-$> doxygen -g
-```
-(Re)generate documentation by editing the `Doxyfile` and running:
+(version 1.9.7). (Re)generate documentation by editing the `Doxyfile` and
+running:
 ```bash
 $> doxygen
 ```
@@ -42,12 +36,9 @@ $> doxygen
 Formatting depends on the [clang-format](https://clang.llvm.org/docs/ClangFormat.html)
 (version 14.0.6) tool. Refer to `.clang-format` for default formatting options.
 A `pre-commit` hook is included in `.githooks` that can be used to format all
-`*.c$` and `*.h$` files prior to commit. Install via:
+`*.c` and `*.h` files prior to commit. Install via:
 ```bash
 $> git config --local core.hooksPath .githooks/
 ```
-If running [direnv](https://direnv.net/), this hook is installed automatically.
-
-## Direnv
-
-
+If running [direnv](https://direnv.net/), this hook is installed automatically
+when entering the directory.