Skip to content

Commit

Permalink
Update README with added file size comparison #58
Browse files Browse the repository at this point in the history
—and other edits.
  • Loading branch information
sannorozco committed Aug 6, 2024
1 parent 58b5237 commit 865bbdf
Showing 1 changed file with 57 additions and 39 deletions.
96 changes: 57 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,25 @@ Alpha version of RobotoFlex made with avar2 data. (work in progress)
Table of contents
-----------------

- [File Size Comparison](#file-size-comparison)
- [Current folder structure](#current-folder-structure)
- [fonts](#Fonts-Folder)
- [ASCII Alpha](#ascii-alpha)
- [LGC Alpha](#lgc-alpha)
- [source](#Source-folder)
- [Parametric avar2](#parametric-avar2)
- [Measurements file](#measurements.json)
- [Blends file](#blends.json)
- [Fences file](#fences.json)
- [The designspace and variable font builder](#the-designspace-and-variable-font-builder)

File Size Comparison
------------------------

File | glyphs | file-size | bytes per glyph
--|--|--|--|
RobotoA2-avar2-VF.ttf | 1,042 | ![GitHub file size in bytes](https://img.shields.io/github/size/googlefonts/roboto-flex-avar2/fonts%2FLGCAlpha%2FRobotoA2-avar2-VF.ttf) | 457.63
RobotoFlex[...].ttf | 948 | ![GitHub file size in bytes](https://img.shields.io/github/size/googlefonts/roboto-flex/fonts%2FRobotoFlex%5BGRAD%2CXOPQ%2CXTRA%2CYOPQ%2CYTAS%2CYTDE%2CYTFI%2CYTLC%2CYTUC%2Copsz%2Cslnt%2Cwdth%2Cwght%5D.ttf) | 1,885.33


Current folder structure
------------------------
Expand All @@ -38,7 +47,7 @@ RobotoA2
<dt>Source</dt>
<dd>This folder contains various source files used to design and build the variable fonts. Source files include UFO font sources, designspace files, Python scripts, as well as additional text files with data for glyph sets, glyph constructions, measurements, parametric blends, and fences.</dd>
<dt>docs</dt>
<dd>This folder is meant to contain font proof tests. It currently contains only a txt with strings comparing Amstelvar1 to AmstelvarA2.
<dd>This folder is meant to contain font proof tests.
</dd>
</dl>

Expand All @@ -50,14 +59,17 @@ The Fonts folder currently contains two subfolders which correspond to different

```
Fonts
├── TechAlpha/
├── AsciiAlpha/
├── LGCAlpha/
├── TechAlpha/
```
<dl>
<dt>AsciiAlpha</dt>
<dd>Our second (successful) attempt at building an avar2 font, ascii only.</dd>
<dt>LGCAlpha</dt>
<dd>THIS contains the latest WIP fonts.</em></dd>
<dt>TechAlpha</dt>
<dd>Our first (failed) attempt at building an avar2 font. ⚠️ <em>These files are no longer useful and can probably be archived in a branch.</em></dd>
<dt>AsciiAlpha</dt>
<dd>Our second (successful) attempt at building an avar2 font, and current development stage. This subfolder contains the current working files (more details below).</dd>
</dl>

### ASCII Alpha
Expand All @@ -79,6 +91,20 @@ AsciiAlpha

\* see [Implementing fences](https://github.com/googlefonts/amstelvar-avar2/issues/4)

### LGC Alpha

```
LGCAlpha
├── RobotoA2-avar2-VF.ttf
└── RobotoA2-avar2-fences-VF.ttf
```
<dl>
<dt>RobotoA2-avar2.ttf</dt>
<dd>Variable font in avar2 format. Blended axes are created by defining mappings from parametric axes to extrema input values, **with fencing mappings**</dd>
<dt>RobotoA2-avar2-no-fences.ttf</dt>
<dd>Variable font in avar2 format. Blended axes are created by defining mappings from parametric axes to extrema input values, **without fencing mappings**</dd>
</dl>


Source folder
------------------
Expand All @@ -88,43 +114,22 @@ Just like the Fonts folder, the Sources folder contains subfolders which corresp
```
Source
├── TechAlpha/
├── Parametric-avar2/
└── tools/
└── Parametric-avar2/
```

<dl>
<dt>TechAlpha</dt>
<dd>Sources in the TechAlpha folder were derived from the original RobotoFlexavar1 parametric sources. A measurements file in JSON format is included, as well as the original extrema sources in a subfolder. <em>With the exception of the `extrema` sources and the measurements file (which are used in the initial blends calculation, see below), all other files are no longer useful and can probably be archived in a branch.</em></dd>
<dt>Parametric-avar2</dt>
<dd>Sources in the Parametric-avar2 folder were recreated from a revised default. These are the current workin files.</dd>
<dd>Sources in the Parametric-avar2 folder were recreated from a revised default. These are the current WIP files.</dd>
<dt>tools</dt>
<dd>This folder collects various small scripts which were used during development of TechAlpha and/or Parametric-avar2 sources. Most of them are no longer needed. The most relevant ones are listed below.</dd>
</dl>

### Tools folder

A selection of production scripts which are worth mentioning:

<dl>
<dt>glyphConstruction folder</dt>
<dd>Contains all the glyphconstruction recipes by script</dd>
<dt>copyGlyphsToSources.py</dt>
<dd>Copy base glyphs from the default to the parametric sources.</dd>
<dt>fixGlyphs.py</dt>
<dd>Used make miscellaneous fixes needed glyphs on all the defined sources.</dd>
<dt>getRecipe.py</dt>
<dd>Used to get the current glyph construction recipes, without anchors.</dd>
</dl>

<dl>
<dt><a href='http://github.com/googlefonts/roboto-flex-avar2/blob/main/Source/tools/mark-components.py'>mark-components.py</a></dt>
<dd>Mark glyphs in the current font containing components with different colors depending on their components' nesting level.</dd>
</dl>


### Parametric-avar2

Folder containing source files, designspace, and variable font.
Folder containing source files, designspace, and features.

```
Roman
Expand All @@ -141,10 +146,8 @@ Roman
│ ├── RobotoA2-wdth151.ufo
│ ├── RobotoA2-wght200.ufo
│ └── RobotoA2-wght800.ufo
├── RobotoA2.designspace
├── RobotoA2-avar1.designspace
├── RobotoA2-avar2.designspace
└── RobotoA2-fences.designspace
└── RobotoA2-avar2-no-fences.designspace
```

<dl>
Expand All @@ -160,20 +163,35 @@ Roman
<dd>Subfolder with files containing OpenType code which can be linked to the source fonts. <em>Currently not used when building the variable fonts.</em></dd>
<dt>instances</dt>
<dd>Subfolder containing instances generated from the parametric sources, which are used to add blended axes to the avar1 designspace. Also useful for comparison with the original RobotoFlex var1 sources for blended extrema.</dd>
<dt>RobotoA2.designspace</dt>
<dd>Basic parametric designspace for use during design and development. Also used to build instances for the avar1 designspace.</dd>
<dt>RobotoA2-avar1.designspace</dt>
<dd>Designspace for building avar1 variable font. Includes the blended instances as sources for blended axes.</dd>
<dt>RobotoA2-avar2.designspace</dt>
<dd>Designspace for building avar2 variable font. Includes avar2 mappings which define blended sources from parametric values.</dd>
<dt>RobotoA2-avar2-fences.designspace</dt>
<dd>Experimental designspace containing avar2 mappings for fences. Includes avar2 mappings of fences for the default and blended extrema.</dd>
<dt>RobotoA2-avar2-no-fences.designspace</dt>
<dd>Designspace for building avar2 variable font. Does not includes avar2 fencing mappings, so we can see the parametric axes’ full range</dd>
<dt>Scratch folder</dt>
<dd>Parametric axis from RobotoFlex public version.</dd>
</dl>

\* All variable fonts are built into the `Fonts/AsciiAlpha` folder.
\* All variable fonts are built into the `Fonts/LGCAlpha` folder.

## Tools folder

A selection of production scripts which are worth mentioning:

<dl>
<dt>glyphConstruction folder</dt>
<dd>Contains all the glyphconstruction recipes by script</dd>
<dt>copyGlyphsToSources.py</dt>
<dd>Copy base glyphs from the default to the parametric sources.</dd>
<dt>fixGlyphs.py</dt>
<dd>Used make miscellaneous fixes needed glyphs on all the defined sources.</dd>
<dt>getRecipe.py</dt>
<dd>Used to get the current glyph construction recipes, without anchors.</dd>
</dl>

<dl>
<dt><a href='http://github.com/googlefonts/roboto-flex-avar2/blob/main/Source/tools/mark-components.py'>mark-components.py</a></dt>
<dd>Mark glyphs in the current font containing components with different colors depending on their components' nesting level.</dd>
</dl>

The designspace and variable font builder
-----------------------------------------
Expand Down

0 comments on commit 865bbdf

Please sign in to comment.