Prettybird

A domain-specific language for programmatically designing fonts

Installation

1. Clone the repo:

   git clone --recurse-submodules https://github.com/CharlesAverill/prettybird.git

2. Install fontforge
   • On Ubuntu:

     add-apt-repository ppa:fontforge/fontforge
     apt update
     apt install fontforge

3. Install prettybird
   • For usage:

     pip install .

   • For development (uses poetry):

     make install
     

   • With Docker:

     docker build . -t prettybird
     docker run -it prettybird /bin/bash

     If you're using Visual Studio Code, you can use the option Dev Containers: Open Folder in Container... to work on this project within the built Docker container.

Usage

Language Documentation

COMING SOON

See showcase.pbd for a showcase of many of the language's features.

Compiler Usage

Prettybird provides a CLI to read in .pbd (such as examples/abcs.pbd) files and compile them to various formats.

prettybird [-h] [--format FORMAT] [--font-name FONT_NAME] [--stdout] input_file

positional arguments:
  input_file            .pbd file to compile

optional arguments:
  -h, --help            show this help message and exit
  --format FORMAT, -f FORMAT
                        Format to convert to. Supported: [BDF, SVG, TTF]
  --font-name FONT_NAME, -n FONT_NAME
                        Name to give to the output font
  --stdout              Print compiled glyph IR to stdout

Within Poetry Environment

Compiles input_file to a TTF font

make run input=[input_file]