update ignore and readme

pull/303/head
rsheeter 2020-05-30 14:19:49 -07:00
parent b81bb6c65e
commit 0aaa0fccce
2 changed files with 13 additions and 14 deletions

1
.gitignore vendored
View File

@ -2,3 +2,4 @@ __pycache__/
*.pyc *.pyc
waveflag waveflag
build/ build/
venv/

View File

@ -7,27 +7,25 @@ Building Noto Color Emoji requires:
- Python 3 - Python 3
- [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) - [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)
- [pngquant](https://pngquant.org/) - [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 ## 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: Intermediate products (compressed image files, for example) will be put into a build subdirectory; the font will be at the top level.
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.
## Using NotoColorEmoji ## Using NotoColorEmoji