Early markdown cleanup support, and an initial clean script.

Soon adding a proper doc about releasing and versioning.

.gitattributes

@@ -1,2 +1,3 @@
+*.md  filter=git-clean-md
 *.tmx filter=git-clean-tmx
 *.tsx filter=git-clean-tsx

Makefile

@@ -200,4 +200,5 @@ run: $(BINARY)
 .PHONY: setup-git
 setup-git:
 	git config filter.git-clean-tmx.clean "$$PWD"/scripts/git-clean-tmx.sh
+	git config filter.git-clean-md.clean "$$PWD"/scripts/git-clean-md.sh
 

docs/RELEASING.md

@@ -0,0 +1,28 @@
+# Releasing
+
+AAAAXY releases are published in the following places:
+
+  - GitHub Releases
+
+TODO(divVerent): add more; provide links.
+
+# Versioning
+
+We follow semantic versioning, but in an adapted form to suppport
+speedrunning leaderboards.
+
+Thus, the version components are incremented as follows:
+
+* Major version must be incremented on changes that likely break
+  existing speedruns.
+  * In particular, slowing down a section required for any speedrun
+    categories, including 100%, requires a major version bump.
+* Minor version must be incremented on changes that likely add faster
+  speedruns.
+  * In particular, simplifying a section or making it optional
+    requires a minor version bump.
+* Patch level must be incremented in any other case.
+
+Note that I say “likely”; if a section is not required for any
+known/published speedrun, slowing it down may not require a major
+version bump.

scripts/git-clean-md.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Simple git filter for tmx and tsx files to clean up relative paths.
+pandoc -f gfm -t gfm \
+	--ascii \
+	--preserve-tabs