|
| 1 | +OpenMoji |
| 2 | +======== |
| 3 | + |
| 4 | +<img width="1157" alt="openmoji-github-keyvisual" src="https://user-images.githubusercontent.com/480224/71999652-1a60c000-3242-11ea-974a-96fef098147b.png"> |
| 5 | + |
| 6 | +Open-source emojis for designers, developers and everyone else! OpenMoji is an open-source project of the HfG Schwäbisch Gmünd by Benedikt Groß, Daniel Utz, 50+ students and external contributors. |
| 7 | + |
| 8 | +👉 [OpenMoji.org/](http://openmoji.org/) |
| 9 | + |
| 10 | +Interact, create, save, and share your work! 🌈`#openmoji` |
| 11 | + |
| 12 | +This GitHub repository contains all of the source files and exported png/svg files of the OpenMoji project. |
| 13 | + |
| 14 | +⚠️ Please note that the master branch is in active development, so if you're looking for stable production version please use one of the releases. |
| 15 | + |
| 16 | + |
| 17 | +## Table of Contents |
| 18 | + |
| 19 | +- [Styleguide](http://openmoji.org/styleguide) our beloved styleguide. |
| 20 | +- [FAQ](FAQ.md) Check if your question has already been answered |
| 21 | +- [Contributing](CONTRIBUTING.md) Pull Requests are welcome! |
| 22 | +- [Developer Setup](CONTRIBUTING.md#developer-setup) how to setup node.js. |
| 23 | +- [Font](font) infos on the OpenMoji-Color and OpenMoji-Black fonts. |
| 24 | +- [Team](http://openmoji.org/about/#team) list of all authors and contributors. |
| 25 | +- [Acknowledgements](http://openmoji.org/about/#acknowledgement) Thanks! |
| 26 | + |
| 27 | + |
| 28 | +## Downloads & Distribution Channels |
| 29 | +You can download, use and "consume" OpenMoji in various ways: |
| 30 | + |
| 31 | +- [SVG](https://github.com/hfg-gmuend/openmoji/releases/latest): Color & Black (production ready) |
| 32 | +- [Fonts](https://github.com/hfg-gmuend/openmoji/releases/latest): Color & Black (experimental) |
| 33 | +- [PNG 618x618](https://github.com/hfg-gmuend/openmoji/releases/latest): Color & Black (production ready) |
| 34 | +- [PNG 72x72](https://github.com/hfg-gmuend/openmoji/releases/latest): Color & Black (production ready) |
| 35 | +- [OpenMoji app](https://itunes.apple.com/us/app/openmoji/id1462636288): for iOS with emoji picker |
| 36 | +- [OpenMoji Stickers](https://itunes.apple.com/us/app/openmoji/id1462636288): for iOS Messages app |
| 37 | +- [OpenMoji Github](https://github.com/hfg-gmuend/openmoji/): `git clone --dept 1 https://github.com/hfg-gmuend/openmoji.git` The OpenMoji repo is big! It is recommended to clone it without the entire history, note the --dept flag. |
| 38 | +- [OpenMoji NPM Package ](https://www.npmjs.com/package/openmoji): `npm install openmoji`. You can also get individual files via [UNPKG ](https://unpkg.com/) direclty e.g.: unpkg.com/ [email protected]/color/svg/1F64B.svg |
| 39 | +- [OpenMoji Jekyll Plugin](https://github.com/azadeh-afzar/OpenMoji-Jekyll-Plugin): `gem install jekyll-openmoji` |
| 40 | + |
| 41 | + |
| 42 | +## Attribution Requirements |
| 43 | +As an open source project, attribution is critical from a legal, practical and motivational perspective. Please give us credits! Common places for attribution are for example: to mention us in your project README, the 'About' section or the footer on a website/in mobile apps. |
| 44 | + |
| 45 | +Attribution suggestion: |
| 46 | + |
| 47 | +> All emojis designed by [OpenMoji](https://openmoji.org/) – the open-source emoji and icon project. License: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/#) |
| 48 | +
|
| 49 | + |
| 50 | +## Anatomy of the OpenMoji Repository |
| 51 | + |
| 52 | +`black/` and `color/` Contains all exported .png and .svg files ¹ |
| 53 | + |
| 54 | +`data/` Contains the central openmoji.json with all meta informations for each emoji ¹ |
| 55 | + |
| 56 | +`font/` Contains the exported OpenMoji fonts ¹ |
| 57 | + |
| 58 | +`guidelines/` Contains various template files related to the styleguide ¹ |
| 59 | + |
| 60 | +`helpers/` Contains various helper scripts e.g. to export to .png and .svg, generate skintones variants, enforce the OpenMoji color palette etc. ² |
| 61 | + |
| 62 | +`src/` Contains all source .svg files of OpenMoji. The files are broken up into folders and files corresponding with the Unicode groups and sub-groups ¹ |
| 63 | + |
| 64 | +`test/` Automated unit tests to ensure consistency across all source .svg files ² |
| 65 | + |
| 66 | + |
| 67 | +## License |
| 68 | +¹ OpenMoji graphics are licensed under the Creative Commons Share Alike License 4.0 ([CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)) |
| 69 | + |
| 70 | +[](https://creativecommons.org/licenses/by-sa/4.0/) |
| 71 | + |
| 72 | +² Code licensed under the GNU Lesser General Public License v3 ([LGPL-3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html)) |
| 73 | + |
| 74 | +[](https://www.gnu.org/licenses/lgpl-3.0.en.html) |
0 commit comments