Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions common/test/keyboards/baseline/README.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add an index of what the various groups of tests are intended to be? Your grouping strategy is not entirely clear to me

Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,25 @@ 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
* web -- .kmn files for test steps, .kmx and .js files

The .kmx files were built with kmcomp, not kmc, in order to ensure that
The .kmx and .js 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:
The keyboards can be built with:

```bat
for %d in (*.kmn) do kmcomp -no-compiler-version -d %d
```bash
./build.sh build
```

This builds the keyboards with debug information and no compiler version
embedded.
Loading