Skip to content

docs: Fix typos in metadata page. #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mturoci wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Fix typos in metadata page. #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ sidebar_position: 3
The `meta` top level key can contain arbitrary metadata documenting the keyboard in question.
The only fields Ergogen interprets and uses from it are:

- **`engine`**: A [semver](https://semver.org/) declaration in the usual form `[major].[minor].[patch]` (so, e.g., `3.1.4`), stating which Ergogen version the config is supposed to work with. The semver check is then performed for *compatibility*, not exact equality, so and `engine` value of `3.1.4` means "at least `3.1.4`, up to (and excluding) `4.0.0`". It is possible that you config would work even on an older or newer engine, but Ergogen will give you an error until you update either your config proper or the `engine` field to match the current environment.
- **`engine`**: A [semver](https://semver.org/) declaration in the usual form `[major].[minor].[patch]` (so, e.g., `3.1.4`), stating which Ergogen version the config is supposed to work with. The semver check is then performed for *compatibility*, not exact equality, so an `engine` value of `3.1.4` means "at least `3.1.4`, up to (and excluding) `4.0.0`". It is possible that your config would work even on an older or newer engine, but Ergogen will give you an error until you update either your config properly or the `engine` field to match the current environment.

- **`version`**: Not to be confused with `engine`, `version` is just a piece of string metadata Ergogen embeds in the KiCAD PCBs it generates.

- **`author`**: Same as `version`, only for the author field of the KiCAD PCB metadata.

Otherwise, feel free to dump anything here from e-mail addresses and GitHub links to your Nan's favorite pie recipe. Ergogen won't complain - only it won't use those fields either.
Otherwise, feel free to dump anything here from e-mail addresses and GitHub links to your Nan's favorite pie recipe. Ergogen won't complain - only it won't use those fields either.