Background
Two accuracy problems in README.md:
-
luarocks install lua-qjson instruction is broken. README line 21 lists luarocks install lua-qjson as the install method, but luarocks.org/modules/api7/lua-qjson returns 404 — the package was never published. The v0.1.0 tag exists locally but users following README will hit an install failure. Local rockspec installation (luarocks make or luarocks install ./rockspec/...) works, but docs don't mention it.
-
ARM64 NEON support claimed without supporting data. The Status section (line 7) mentions "ARM64 NEON/PMULL structural scanner (runtime-dispatched)" alongside AVX2/PCLMUL, suggesting equivalent maturity. But all benchmark data (README and docs/benchmarks.md) is x86_64 only (AMD EPYC Rome, Zen 2). NEON support exists in code (src/scan/neon.rs, tests/scanner_crosscheck.rs validates correctness) but has zero published performance data. Users evaluating qjson for ARM deployment have no performance expectations to go on.
Goal
README install instructions must work; the ARM64 NEON claim must either be backed by benchmark data or explicitly qualified with its current limitations.
Non-goals
- Publishing the package to luarocks.org (separate Issue)
- Adding CI benchmark gates for ARM (separate Issue)
Acceptance Criteria
Task Checklist
1. Fix install instructions
2. Clarify ARM64 status
3. Validation
Notes / Decisions
Background
Two accuracy problems in
README.md:luarocks install lua-qjsoninstruction is broken. README line 21 listsluarocks install lua-qjsonas the install method, butluarocks.org/modules/api7/lua-qjsonreturns 404 — the package was never published. Thev0.1.0tag exists locally but users following README will hit an install failure. Local rockspec installation (luarocks makeorluarocks install ./rockspec/...) works, but docs don't mention it.ARM64 NEON support claimed without supporting data. The Status section (line 7) mentions "ARM64 NEON/PMULL structural scanner (runtime-dispatched)" alongside AVX2/PCLMUL, suggesting equivalent maturity. But all benchmark data (README and
docs/benchmarks.md) is x86_64 only (AMD EPYC Rome, Zen 2). NEON support exists in code (src/scan/neon.rs,tests/scanner_crosscheck.rsvalidates correctness) but has zero published performance data. Users evaluating qjson for ARM deployment have no performance expectations to go on.Goal
README install instructions must work; the ARM64 NEON claim must either be backed by benchmark data or explicitly qualified with its current limitations.
Non-goals
Acceptance Criteria
qjson(no longer depends on the missing luarocks.org package)Task Checklist
1. Fix install instructions
luarocks makeorluarocks install ./rockspec/lua-qjson-0.1.0-1.rockspecsucceeds## Installingsection, replacingluarocks install lua-qjsonwith the local install approach2. Clarify ARM64 status
docs/benchmarks.mdEnvironment table (explicitly notex86_64 only)3. Validation
Notes / Decisions
tests/scanner_crosscheck.rs— proptest validates AVX2/NEON/scalar output identity). No code changes needed.