From 3d48730ad98a9ace48b0074c1980d8420e1a1ce2 Mon Sep 17 00:00:00 2001 From: Constantin A <10349490+C1710@users.noreply.github.com> Date: Sun, 20 Jun 2021 10:50:33 +0200 Subject: [PATCH] Update README.md Updated for new build process --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 10c155e35..f05237946 100644 --- a/README.md +++ b/README.md @@ -24,24 +24,38 @@ But now to the original content of this Readme: Color and Black-and-White Noto emoji fonts, and tools for working with them. -## Building NotoColorEmoji +## ~~Building NotoColorEmoji~~ -Building NotoColorEmoji currently requires a Python 2.x wide build. To build +~~Building NotoColorEmoji currently requires a Python 2.x wide build. To build the emoji font you will require a few files from nototools. Clone a copy from https://github.com/googlei18n/nototools and either put it in your PYTHONPATH or use 'python setup.py develop' ('install' currently won't fully install all the data used by nototools). You will also need fontTools, get it from -https://github.com/behdad/fonttools.git. +https://github.com/behdad/fonttools.git.~~ -Then run `make`. NotoColorEmoji is the default target. It's suggested to use `-j`, +~~Then run `make`. NotoColorEmoji is the default target. It's suggested to use `-j`, especially if you are using zopflipng for compression. Intermediate products (compressed image files, for example) will be put into a build subdirectory; the -font will be at the top level. +font will be at the top level.~~ -## Docker build +## Building Blobmoji 13+ -Alternatively, you can also build the font within Docker through the provided Dockerfile. -Just run `docker build . -t blobmoji && docker run --rm -it -v "$PWD/output:/output" blobmoji`. The resulting font will reside in the 'output' folder in your current working directory. +_Building is now done using [emoji_builder](https://github.com/C1710/emoji_builder/) (name WIP). Once you have it running, you can build it using the following command (you'll need to replace `emoji_builder` by the executable you use, e.g. `emoji_builder.exe` and maybe including the path. I recommend copying it into the `blobmoji`-directory):_ +``` +emoji_builder --flags .\third_party\region-flags\svg blobmoji -w -a .\emoji_aliases.txt --ttx-tmpl .\NotoColorEmoji.tmpl.ttx.tmpl --palette .\Blobmoji.gpl +``` +- `--flags`: Use the directory conaining the flags +- `-w` add a wave-effect to the flags +- `-a` use an alias file +- `--ttx-tmpl` Use the template for the font metadata +- `--palette` normalize the colors to a specific color palette in the GIMP format (which is a derivation of the color palette present in the [2014 _Material Design_](https://material.io/archive/guidelines/style/color.html#color-color-palette)) + +## ~~Docker build~~ + +~~Alternatively, you can also build the font within Docker through the provided Dockerfile. +Just run `docker build . -t blobmoji && docker run --rm -it -v "$PWD/output:/output" blobmoji`. The resulting font will reside in the 'output' folder in your current working directory.~~ + +The Docker build method isn't available for `emoji_builder` yet ## Using NotoColorEmoji