Skip to content

Commit f784f41

Browse files
committed
[README.md] add axis definitions section
includes axis definition syntax, including the new syntax added to support L3 restricted sub-spaces
1 parent b836f14 commit f784f41

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,22 @@ User docs are available at https://slice-gui.netlify.app/docs/
1515
- [Installation](https://slice-gui.netlify.app/docs/install/)
1616
- [Usage](https://slice-gui.netlify.app/docs/usage/)
1717

18+
## Axis definitions
19+
20+
Slice currently supports combinations of the following axis definition types in output fonts:
21+
22+
- Fixed instance locations
23+
- Level 3 restricted axis ranges (must include original axis default value in the new, smaller axis range)<sup>[[1](#footnote1)]</sup>
24+
- Full, original variable axis ranges
25+
26+
Define your font axes with the syntax in the table below.
27+
28+
|Axis definition | Axis Editor Syntax | Example |
29+
| --- | --- | --- |
30+
| Fixed axis location| Integer or float value | `400.0` |
31+
| Restricted axis range | Colon-delimited min:max integer or float range | `200:700` |
32+
| Full axis range | Leave editor row blank | n/a |
33+
1834
## Issues
1935

2036
Please file issues on the [project tracker](https://github.com/source-foundry/Slice/issues).
@@ -44,3 +60,8 @@ Please see the [thirdparty directory](https://github.com/source-foundry/Slice/tr
4460
<a href="https://www.netlify.com">
4561
<img src="https://www.netlify.com/img/global/badges/netlify-light.svg" alt="Deploys by Netlify" />
4662
</a>
63+
64+
65+
---
66+
67+
<small><a id="footnote1">1</a>: Default axis locations are required to compile valid variable font format files. The default axis value defined in the original font must be included in the restricted axis range due to the lack of compiler support for default axis location moves during the slicing process. We intend to support default axis location moves when it is possible to do so. [This issue is being tracked on our GitHub tracker](https://github.com/source-foundry/Slice/issues/32).</small>

0 commit comments

Comments
 (0)