From e9a146586b521e230856e6014733da4652dd109b Mon Sep 17 00:00:00 2001 From: Rod S Date: Tue, 6 Sep 2022 11:33:22 -0700 Subject: [PATCH] Consolidate instructions --- BUILD.md | 36 ++++++++++++++++++++++++++++++++++++ colrv1/README.md | 36 ------------------------------------ 2 files changed, 36 insertions(+), 36 deletions(-) create mode 100644 BUILD.md delete mode 100644 colrv1/README.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 000000000..e7ee14f19 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,36 @@ +# Build instructions + +Typically build the CBDT then the COLRv1 as COLRv1 copies some information from CBDT. + +## CBDT + +```bash +rm -rf venv # in case you have an old borked venv! +python3 -m venv venv +source venv/bin/activate +pip install -r requirements.txt +rm -rf build/ && time make -j 48 +# Should take 2-3 minutes to create noto-emoji/NotoColorEmoji.ttf + +mv *.ttf fonts/ +``` + +## COLRv1 + +```bash +# If you are updating to a new Unicode rev, update configs +(cd colrv1 && python colrv1_generate_configs.py) +git diff colrv1/*.toml + +# Compile the fonts +(cd colrv1 && rm -rf build/ && time nanoemoji *.toml) +cp colrv1/build/NotoColorEmoji.ttf fonts/Noto-COLRv1.ttf +cp colrv1/build/NotoColorEmoji-noflags.ttf fonts/Noto-COLRv1-noflags.ttf + +# Post-process them +python colrv1_postproc.py +``` + +## Emojicompat + +TODO detailed instructions \ No newline at end of file diff --git a/colrv1/README.md b/colrv1/README.md deleted file mode 100644 index 7a76e16a4..000000000 --- a/colrv1/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# COLRv1 Build - -We assume the bitmap version with equivalent coverage exists and -contains emojicompat metadata. - -## Build Steps - -1. Check the list of sources in the config files is in sync with the current sources - - ```shell - # running from the noto-emoji repository root directory - python colrv1_generate_configs.py - git diff colrv1/*.toml - ``` - - If configs are in sync, the `colrv1/*.toml` files should contain no diffs. - -1. Compile the COLRv1 fonts - - ```shell - time nanoemoji *.toml - cp build/NotoColorEmoji.ttf ../fonts/Noto-COLRv1.ttf - cp build/NotoColorEmoji-noflags.ttf ../fonts/Noto-COLRv1-noflags.ttf - ``` - -1. Post-process COLRv1 fonts - * Adds some additional sequences, fixes up `name`, etc - * At time of writing only the noflags version is for Android - - ```shell - # Assumed to be in a python3 environment with requirements.txt fulfilled - python colrv1_postproc.py - ``` - -1. Add emojicompat metadata to the Android font and pass to the Android team - * TODO write detailed instructions \ No newline at end of file