From 9aeb5b6700e426f56c647e2068b4247a41b93490 Mon Sep 17 00:00:00 2001 From: Tim Claridge Date: Sun, 14 Jun 2026 11:39:45 +1200 Subject: [PATCH] docs: note git submodule init required for spec tests The official Mustache spec compliance tests read .yml data from the src/test/resources/specs submodule. Document 'git submodule update --init' so a fresh clone can build and run the full test suite. Co-Authored-By: Claude Opus 4.8 --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 09eeffa..14b7f5b 100644 --- a/README.md +++ b/README.md @@ -555,6 +555,20 @@ the defaults), it is safe to share a `Mustache.Compiler` instance across threads templates. If you pass immutable data to your templates when executing, it is safe to have multiple threads simultaneously execute a single `Template` instance. +Building from Source +==================== + +The test suite includes the official [Mustache spec](https://github.com/mustache/spec) +compliance tests, which live in a git submodule under `src/test/resources/specs`. After cloning, +initialise it before building or the spec tests will fail to find their `.yml` data files: + +``` +git submodule update --init +``` + +Then build with `mvn install`. (The submodule is pinned to a known-good spec revision; newer spec +revisions add optional tests this implementation does not yet support.) + Limitations ===========