Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelngs authored Apr 13, 2020
1 parent e91f73f commit df79117
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,29 @@ Color and Black-and-White Apple color emoji fonts, and tools for working with th

The code provided is for educational purposes only. Apple is a trademark of Apple Inc., registered in the U.S. and other countries.

## Building AppleColorEmoji

Building AppleColorEmoji 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.

Then run `make` and `make install`. AppleColorEmoji 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.
## Installing prebuilt AppleColorEmoji font

- Download the latest release of `AppleColorEmoji.ttf` at the [Release Page](https://github.com/samuelngs/apple-emoji-linux/releases)
- Copy `AppleColorEmoji.ttf` to `~/.local/share/fonts`.
- Rebuild the font cache with `fc-cache -f -v`.
- Now you are set!

## Building AppleColorEmoji from source

- Install Python 2, building `AppleColorEmoji.ttf` currently requires a Python 2.x wide build.
- Install [fonttools python package](https://github.com/fonttools/fonttools).
- On the command line, enter: `python -m pip install fonttools`
- Install [nototools python package](https://github.com/googlei18n/nototools).
- On the command line, enter: `python -m pip install https://github.com/googlefonts/nototools/archive/v0.2.1.tar.gz`, or
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).
- Install [Optipng](http://optipng.sourceforge.net/), [Zopfli](https://github.com/google/zopfli) and [Pngquant](https://pngquant.org/).
- On RedHat based systems, run `yum install optipng zopfli pngquant`
- Or on Debian or Ubuntu, you may run `apt-get install optipng zopfli pngquant` at the command line.
- Clone the [source repository](https://github.com/samuelngs/apple-emoji-linux) from Github
- Open a terminal or console prompt, change to the directory where you cloned `apple-emoji-linux`, and type `make -j` to build `AppleColorEmoji.ttf` from source.
- If you wish to install the built `AppleColorEmoji.ttf` to your system, execute `make install`,
- Then rebuild the your system font cache with `fc-cache -f -v`

## Using AppleColorEmoji

Expand Down

0 comments on commit df79117

Please sign in to comment.