From 40b072d99784b273a397578a5ded6a2fae53eec9 Mon Sep 17 00:00:00 2001 From: Sebastian Crane Date: Sun, 30 Apr 2023 00:38:13 +0100 Subject: [PATCH] Document required system dependencies in README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index d86672f..c7008b7 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,10 @@ Add the following to your `Cargo.toml` dependencies: forma = { version = "0.1.0", package = "forma-render" } ``` +### System dependencies + +There are some system dependencies that won't be downloaded automatically by Cargo. To build forma, you will need a C toolchain (such as `alpine-sdk` on Alpine Linux, or `build-essential` on Debian), and to run the demos, you'll additionally need to install [CMake](https://repology.org/project/cmake), [fontconfig](https://repology.org/project/fontconfig) and [freetype](https://repology.org/project/freetype). + ## 4-stage Pipeline | 1. Curve flattening | 2. Line segment rasterization | 3. Sorting | 4. Painting |