readme prerequisites

pull/297/head
guidotheelen 2020-04-14 16:56:16 +02:00
parent 4596ae8a0d
commit ac9a6397f7
2 changed files with 8 additions and 2 deletions

View File

@ -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

View File

@ -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`: