1
0
Fork 0
freesewing/markdown/dev/reference/api/config/en.md

39 lines
877 B
Markdown
Raw Normal View History

---
title: Pattern configuration file
---
2022-02-05 17:44:23 +01:00
The pattern configuration file holds a variety of information about the
pattern, its various parts, what measurements it requires, the options it
accepts and so on.
2022-02-05 17:44:23 +01:00
It is part of the initial design and as such static in nature.
<Note>
This is about the pattern configuration file, used at build-time.
For run-time configuration, see [Pattern settings](/reference/api/settings).
</Note>
2022-02-05 17:44:23 +01:00
## Structure
The pattern configuration is a plain object with one or more of the following
properties:
<ReadMore />
## Example
Below is a minimal example. Look at [the Aaron config file][aaron] for a full example.
```js
const config = {
version: '0.0.1',
name: "sorcha",
// More configuration here
}
```
[aaron]: https://github.com/freesewing/freesewing/blob/3ca5d0edfe54c7ac20aaf3af2f3544aee72f9b99/designs/aaron/config/index.js