Consolidate instructions

pull/401/head^2
Rod S 2022-09-06 11:33:22 -07:00
parent 1b5d40344a
commit e9a146586b
2 changed files with 36 additions and 36 deletions

36
BUILD.md 100644
View File

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

View File

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