From ac9a6397f78a8e2685d00977b40ab46121d9ed80 Mon Sep 17 00:00:00 2001 From: guidotheelen Date: Tue, 14 Apr 2020 16:56:16 +0200 Subject: [PATCH] readme prerequisites --- Makefile | 2 +- README.md | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 148ca66fa..20b75cfed 100644 --- a/Makefile +++ b/Makefile @@ -134,7 +134,7 @@ compressed: $(ALL_COMPRESSED_FILES) check_compress_tool: ifdef MISSING_ZOPFLI ifdef MISSING_OPTIPNG - $(error "neither $(ZOPFLIPNG) nor $(OPTIPNG) is available") + $(error "neither $(ZOPFLIPNG) nor $(OPTIPNG) is available. For installation instructions, see README.md") else @echo "using $(OPTIPNG)" endif diff --git a/README.md b/README.md index 9376d1745..f7a93961a 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,14 @@ # Noto Emoji Color and Black-and-White Noto emoji fonts, and tools for working with them. +## Prerequisites +- This project uses Python 3. +- You need either [zopflipng](https://github.com/google/zopfli) or [optipng](ttp://optipng.sourceforge.net/). (Zopflipng is better (about 5-10%) but much slower.) +- You need [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) + + ## Building NotoColorEmoji -Building NotoColorEmoji requires Python 3, and uses virtual environments to manage dependencies. Use the following steps to get up and running. +This project uses a virtual environment to manage dependencies. Use the following steps to get up and running. Create a virtual environment called `noto-emoji-env`: