spiegel-keyman/common/test/keyboards/baseline/README.md
Marc Durdin c18ef54029 refactor(common): move core baseline tests into common
Decided to use the name `baseline` for this set of tests. They can be
used by any project in the repo now. Tests will be treated as shared,
and not modified (except in the case of a buggy test).

* Moves .kmn files, add `&NAME` line (don't use meson templating for
  these files)
* Generates reference .kmx files using kmcomp for use as a baseline with
  kmcmplib (kmc) tests, and for linux tests
* Updates references in core, kmcmplib, and linux builds
* Renames all the .kmn / .kmx to use a standardized, clean name format
  (this was needed for building packages in the core tests)
2023-03-28 05:20:45 +07:00

863 B

Keyboard baseline fixtures

This folder contains a set of keyboards that are used by multiple projects to verify behaviour, both for compilation, and for runtime tests.

The following projects are known to use these keyboards:

  • core -- .kmn files only, compiled with kmc during tests
  • developer/kmcmplib -- .kmn files, compiled for tests, and .kmx as reference
  • linux -- .kmn files for test steps only, .kmx files

The .kmx files were built with kmcomp, not kmc, in order to ensure that developer/kmcmplib gets a valid baseline reference.

Once kmc is stable, it is possible that we will be able to use the kmc npm module to build .kmx for all projects that need them.

Build parameters

Keyboards were built with debug information and no compiler version embedded, with kmcomp 16.0.138:

for %d in (*.kmn) do kmcomp -no-compiler-version -d %d