Skip to content

Commit

Permalink
Document configuration file better
Browse files Browse the repository at this point in the history
  • Loading branch information
simoncozens committed Jun 13, 2024
1 parent 380bfcc commit 26bf9ae
Showing 1 changed file with 59 additions and 4 deletions.
63 changes: 59 additions & 4 deletions sources/config.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,67 @@
# The configuration for the builder is in YAML format. You can use

Check warning on line 1 in sources/config.yaml

View workflow job for this annotation

GitHub Actions / Build and test

Fontbakery failures

The fontbakery QA check reported errors in your font. Please check the generated report.
# https://www.yamllint.com/ to make sure that your configuration
# file is correctly formatted.

# First we need to define the source files to build. Please list
# all sources in the same family. These are expected to be in the
# sources/ directory, so all paths should be relative to that
# directory.
sources:
- RadioCanadaDisplay.glyphs
- RadioCanadaDisplay-Italic.glyphs
axisOrder:
- wght
# You don't have to supply the family name, but builds are slightly
# faster if you do.
familyName: "Radio Canada Display"
buildStatic: true

# Next you can supply alternative paths for where you want the
# binaries to live. But we'd recommend you stick to the defaults
# especially if you are planning to upload your font to Google Fonts.

# outputDir: ../fonts
# vfDir: $outputDir/variable
# ttDir: $outputDir/ttf
# otDir: $outputDir/otf
# woffDir: $outputDir/webfonts

# The following entries, which are either "true" or "false"
# determine which targets to build. We turn off OTFs for this demo.

# buildVariable: true
# buildStatic: true
# buildTTF: true
buildOTF: false
buildWebfont: false
# buildSmallCap: false

# The next flags control autohinting.
# autohintTTF: true
# autohintOTF: false
# ttfaUseScript: false # Set this to true if your font is not Latin

# The "fix" operation can optionally fix some problems which
# are better dealt with in the font sources. Set this to true if you
# want gftools-fix to automatically fix source problems.
# includeSourceFixes: false

# These options give fine-grained control over how fontmake builds
# the fonts.
# flattenComponents: true
# decomposeTransformedComponents: true
# checkCompatibility: true
# overlaps: booleanOperations
# expandFeaturesToInstances: false
# reverseOutlineDirection: true
# removeOutlineOverlaps: true
# extraFontmakeArgs: ""
# extraVariableFontmakeArgs: ""
# extraStaticFontmakeArgs: ""
# glyphData: GlyphData.xml

# This control how STAT tables are generated. The STAT table is
# specified here as a list of axis names, tags and values. You
# can either map a list to each output VF, or provide a single
# list which is used for all VFs. Note that the build will fail
# if you specify a dictionary which does not contain an entry
# for each VF file built.
stat:
RadioCanadaDisplay[wght].ttf:
- name: Weight
Expand Down

0 comments on commit 26bf9ae

Please sign in to comment.