chore: Cleanup, add CI

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: ADR Tools
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  lint:
+    name: Lint
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: reviewdoc/action-setup
+      - run: reviewdog -version
+
+  test:
+    name: Test - ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check results
+        run: make

.github/workflows/reviewdog.yml

@@ -0,0 +1,40 @@
+name: Reviewdog
+
+on:
+  pull_request:
+
+jobs:
+  markdownlint:
+    name: markdownlint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: reviewdog/[email protected]
+        with:
+          reporter: github-pr-review
+
+  shellcheck:
+    name: shellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: reviewdog/[email protected]
+        with:
+          reporter: github-pr-review
+          check_all_files_with_shebangs: 'true'
+
+  typos:
+    name: typos
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: reviewdog/[email protected]
+
+  misspell:
+    name: misspell
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: reviewdog/[email protected]
+        with:
+          locale: UK

INSTALL.md

@@ -19,7 +19,7 @@ You can install with Git, if you want to be on the bleeding edge:
 
 ### Git for Windows: git bash
 
-When using git bash within [Git for Windows][], the scripts can simply be put in
+When using git bash within [Git for Windows][], the scripts can be put in
 `usr\bin` in the installation directory. That directory usually is `C:\Program
 Files\Git\usr\bin`.
 

src/_adr_generate_table

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -e
 eval "$("$(dirname "$0")"/adr-config)"
 

src/_adr_help_config

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -e
 eval "$("$(dirname "$0")"/adr-config)"
 
@@ -8,7 +8,7 @@ usage: adr config
 Displays the current configuration.
 
 The adr_template_dir parameter defaults to the adr installation
-but can be overwriten if a custom template is required by settting the
+but can be overwritten if a custom template is required by setting the
 ADR_TEMPLATE environment variable to the custom file.
 
     export ADR_TEMPLATE=<adr template file>

src/adr-edit

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -e
 eval "$("$(dirname "$0")"/adr-config)"
 

src/adr-generate

@@ -6,7 +6,7 @@ eval "$("$(dirname "$0")"/adr-config)"
 ##
 ## Generates summary documentation about the architecture decision records
 ## that is typically fed into the tool chain for publishing a project's
-## documentatation.
+## documentation.
 ##
 ## To list the report types that can be generated, run:
 ##