From 8307006336ddae8867bf0226ef55c76e56f70e41 Mon Sep 17 00:00:00 2001 From: "pdroidandroid@gmail.com" Date: Wed, 26 Jan 2022 20:59:04 +0100 Subject: [PATCH] Added README.md to emoji module --- tools/make-emoji-keys/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 tools/make-emoji-keys/README.md diff --git a/tools/make-emoji-keys/README.md b/tools/make-emoji-keys/README.md new file mode 100644 index 000000000..aee50bf8c --- /dev/null +++ b/tools/make-emoji-keys/README.md @@ -0,0 +1,21 @@ +# Emoji tools + +This module takes care of generating emoji data bundled with Openboard. +Basically data is generated in three steps: +1. Unicode emoji table provides code points and grouping plus ordering. +2. Local file lists every new emojis supported for every android version since 4.4. +3. Emoji sequences are merged with their base version and formatted into android resource file. + +### Generate emoji-categories.xml + +A gradle task called 'makeEmoji' builds and runs this tool to generate android resouce file which. Path to openboard's res directory is automatically set so the file is ready to be bundled at build. + +### Update to latest emoji version + +* Get new emoji data from Unicode official repository located here: https://unicode.org/Public/emoji. +* Create a new directory in (/src/main/resources/emoji/ucd)[/src/main/resources/emoji/ucd] and name it as a decimal number corresponding to Unicode's version. +* Update (android-emoji-support.txt)[/src/main/resources/emoji/android-emoji-support.txt] with new emojis supported in latest Android versions. +* Run : + ```sh + ./gradlew tools:make-emoji-keys:makeEmoji + ``` \ No newline at end of file