Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

better readme #144

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

better readme #144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,23 @@
#### DISCLAIMER:
I am **neither** affiliated nor in _any_ relationship to the original creators or to Emojipedia or anything or anyone else.

![Noto](images/noto.png)

This repository is intended to continue the development of the Blob emojis, originally invented in 2013, which have been replaced by different round designs more similar to other vendors, in Android Oreo from 2017.

This repository is intended to continue the development of the Blob emojis which have been replaced by different designs in 2017.

Please note that I did not create most of the emojis. You can find an overview of the changes I made in the file `MODIFIED.md`
Please note that I did not create most of the emojis; you can find an overview of the changes compared to the original state in `MODIFIED.md`

Most information on this fork will be included in the [Wiki](https://github.com/C1710/blobmoji/wiki). There you'll find more detailed build instructions and other helpful information on how to use this font and much more.

_[Emojipedia®](https://emojipedia.org) is a registered trademark of Emojipedia Pty Ltd_
_Microsoft, Windows are trademarks of the Microsoft group of companies._
_Noto is a trademark of Google Inc._

# How to use this font
## Using the font
See https://github.com/C1710/blobmoji/wiki/Installation-and-Usage

# How to build it
## Building
Starting with Emoji 13, the build scripts used by Noto Emoji are not (directly) used anymore.
Instead the font is built using a [new build toolset](https://github.com/C1710/emoji_builder), which works on top of these scripts and handles rendering and preprocessing the images as well as a completeness validation.

Instructions on how to build the software can be found in its repository.
Instructions on how to build the font can be found in its repository.

Once you have it running, you can build it using the following command (you'll need to replace `emoji_builder` by the executable you use, e.g. `emoji_builder.exe` and maybe including the path):
```
Expand All @@ -36,12 +32,12 @@ emoji_builder --flags ./third_party/region-flags/svg blobmoji -w -a ./emoji_alia

The build script I use myself is included. Please be aware that this is made to be used on Windows and requires `emoji_builder` to be installed and included in PATH, as well as an adjacent directory containing the EmojiCompat scripts and unicode tables.

# Docker Build
## Docker Build
Alternatively, you can also build the font within Docker through the provided Dockerfile.
Just run `docker build . -t blobmoji && docker run --rm -it -v "$PWD/output:/output" blobmoji`. The resulting font will reside in the 'output' folder in your current working directory (Note that the volume assignment `-v "$PWD/output:/output"` might not work correctly on Windows).


# License
## License

From Noto Emoji:
> Emoji fonts (under the fonts subdirectory) are under the
Expand All @@ -50,12 +46,12 @@ Tools and most image resources are under the [Apache license, version 2.0](./LIC
Flag images under third_party/region-flags are in the public domain or
otherwise exempt from copyright ([more info](third_party/region-flags/LICENSE)).

This license also applies to this repository.
This repository is licensed under these same terms as Noto Emoji.

*In compliance with the [APACHE-2.0](https://opensource.org/licenses/Apache-2.0) license: I declare that this version of the program contains my modifications, which can be seen through the usual "git" mechanism.*


# Contributing
## Contributing

As there is not much going on here, there are as of now no complicated rules for contribution.
You can simply start pull requests, issues and discussions. I'll try to respond as soon as possible.
Expand All @@ -65,3 +61,11 @@ Feel free to add yourself to `CONTRIBUTORS_Blob` when creating a PR :)

_Please try to use the discussion feature for artistic topics, like the style of the emojis. Issues are better suited for real issues, like not being able to use the font or really **missing** characters, etc._

> ## Disclaimers
> I am **neither** affiliated nor in _any_ relationship to the original creators of the Noto Color Emoji font or to Emojipedia or anything or anyone else.
>
> > Android™ is a registered trademark or trademark of Google Inc in the United States and/or other countries.\
> > Unicode is a registered trademark of Unicode, Inc. in the United States and other countries.\
> > Emojipedia® is a registered trademark of Emojipedia Pty Ltd\
> > Microsoft, Windows are trademarks of the Microsoft group of companies.\
> > Noto is a trademark of Google Inc.