Merge pull request #320 from adrienntindall/mic-test

Mic Test Overlay

Author: PikalaxALT

.githooks/pre-commit

@@ -1,9 +1,9 @@
-#!/bin/sh
-# Redirect output to stderr.
-exec 1>&2
-
-# Run clang-format on staged files; abort the commit if any files are changed
-if ! git clang-format --extensions c,cpp,h,hpp ; then
-    echo "linting made changes to source files; aborting commit"
-    exit 1
-fi
+#!/bin/sh
+# Redirect output to stderr.
+exec 1>&2
+
+# Run clang-format on staged files; abort the commit if any files are changed
+if ! git clang-format --extensions c,cpp,h,hpp ; then
+    echo "linting made changes to source files; aborting commit"
+    exit 1
+fi

.github/calcrom/webhook.sh

@@ -1,7 +1,7 @@
 #!/bin/bash -ex
 
-# Only run this script if it's the master branch build.
-if [[ "$GITHUB_REF" != "refs/heads/master" || "$GITHUB_EVENT_NAME" != "push" ]]; then
+# Only run this script if it's the main branch build.
+if [[ "$GITHUB_REF" != "refs/heads/main" || "$GITHUB_EVENT_NAME" != "push" ]]; then
   exit 0
 fi
 

.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: build
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
   workflow_dispatch:
 
@@ -113,4 +113,3 @@ jobs:
           cwd: "./xmap"
           add: "*.xMAP"
           message: ${{ env.XMAP_COMMIT_MSG }}
-

CONTRIBUTING.md

@@ -12,7 +12,7 @@ This repository includes an opinionated `clang-format` specification to ensure t
 
 ### Requirements
 
-- `clang-format@17` or newer
+- `clang-format@18` or newer
 
 ### Usage
 
@@ -47,3 +47,23 @@ asm void func() {
 // clang-format on
 #endif // NONMATCHING
 ```
+
+### Ubuntu (WSL) Installation
+
+On older versions of Ubuntu, clang-format will default to earlier versions.
+To install clang-format-18 on Ubuntu (WSL), run the following:
+```sh
+wget https://apt.llvm.org/llvm.sh
+chmod +x llvm.sh
+sudo ./llvm.sh 18
+sudo apt install clang-format-18
+```
+And then create a symbolic link:
+```sh
+ln -s /usr/bin/clang-format-18 /usr/bin/clang-format
+```
+
+If you're using the pre-commit hook, you also want to set up a symlink for git:
+```sh
+git config alias.clang-format clang-format-18
+```