corwin/card-game.el
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

doc: generate README.md from README.org (Emacs batch ox-md)

Browse source 
Add build.el + pre-commit hook so README.org stays the source and
README.md is regenerated for GitHub/MELPA.  Refresh README (screenshots,
Crapette, use-package, new customs).  Makefile: readme/hooks/info-emacs
targets; ship README.md.
This commit is contained in:
Corwin Brust 2026-07-01 14:06:02 -05:00
parent 556485cb6b
commit 69a4de7538
9 changed files with 541 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

37
hooks/pre-commit Normal file
View file

@ -0,0 +1,37 @@
#!/usr/bin/env sh
# hooks/pre-commit -- regenerate README.md from README.org on commit.
#
# When README.org (or build.el) is part of the commit, re-run the batch
# Org -> Markdown export and stage the refreshed README.md so it travels
# in the same commit. GitHub and MELPA render Markdown better than Org.
#
# Lightweight by design: no sentinel file, no post-commit --amend. If
# nothing relevant changed, the hook exits immediately.
#
# Install: make hooks (or: ln -s ../../hooks/pre-commit .git/hooks/pre-commit)
#
# Set EMACS in the environment if the Emacs binary is not named "emacs"
# on the PATH git sees (common on Windows/MSYS2).
set -e
REPO_ROOT="$(git rev-parse --show-toplevel)"
cd "$REPO_ROOT"
# Only act when README.org or the exporter itself is staged.
if ! git diff --cached --name-only | grep -Eq '^(README\.org|build\.el)$'; then
exit 0
fi
EMACS_BIN="${EMACS:-emacs}"
if ! command -v "$EMACS_BIN" >/dev/null 2>&1; then
echo "pre-commit: WARNING: '$EMACS_BIN' not found; README.md not regenerated." >&2
echo "pre-commit: set EMACS to your Emacs binary, or run 'make readme'." >&2
exit 0
fi
echo "pre-commit: regenerating README.md from README.org"
"$EMACS_BIN" -Q --batch -l build.el
git add README.md
exit 0