Skip to content

Commit

Permalink
update ignore and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rsheeter committed May 30, 2020
1 parent b81bb6c commit 0aaa0fc
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ __pycache__/
*.pyc
waveflag
build/
venv/
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,25 @@ Building Noto Color Emoji requires:
- Python 3
- [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)
- [pngquant](https://pngquant.org/)
- Either [zopflipng](https://github.com/google/zopfli) or [optipng](http://optipng.sourceforge.net/). Zopflipng is better (about 5-10%) but much slower.
- [zopflipng](https://github.com/google/zopfli)

## Building NotoColorEmoji
This project uses a virtual environment 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`:
```shell
# make sure you have the Prerequisites

python3 -m venv noto-emoji-env
# create & activate a virtual environment
python3 -m venv venv
source venv/bin/activate

Activate the virtual environment:
# install python requirements
pip install -r requirements.txt

source noto-emoji-env/bin/activate
time make -j
```

Install the Python requirements with:

pip install -r requirements.txt

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.
Intermediate products (compressed image files, for example) will be put into a build subdirectory; the font will be at the top level.

## Using NotoColorEmoji

Expand Down

0 comments on commit 0aaa0fc

Please sign in to comment.