summaryrefslogtreecommitdiffstats
path: root/tools/image_generator/README.md
diff options
context:
space:
mode:
authorTianjie Xu <xunchang@google.com>2018-10-13 07:30:07 +0200
committerandroid-build-merger <android-build-merger@google.com>2018-10-13 07:30:07 +0200
commita74581a635ad2b9f844c1b5110c46fc1733958fa (patch)
tree82752ee3ec39d98c17b822b88c380da118ae8ee7 /tools/image_generator/README.md
parentMerge "Add function to load the key from x509.pem file" (diff)
parentMerge "Use a host java program to generate the background text" (diff)
downloadandroid_bootable_recovery-a74581a635ad2b9f844c1b5110c46fc1733958fa.tar
android_bootable_recovery-a74581a635ad2b9f844c1b5110c46fc1733958fa.tar.gz
android_bootable_recovery-a74581a635ad2b9f844c1b5110c46fc1733958fa.tar.bz2
android_bootable_recovery-a74581a635ad2b9f844c1b5110c46fc1733958fa.tar.lz
android_bootable_recovery-a74581a635ad2b9f844c1b5110c46fc1733958fa.tar.xz
android_bootable_recovery-a74581a635ad2b9f844c1b5110c46fc1733958fa.tar.zst
android_bootable_recovery-a74581a635ad2b9f844c1b5110c46fc1733958fa.zip
Diffstat (limited to 'tools/image_generator/README.md')
-rw-r--r--tools/image_generator/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/tools/image_generator/README.md b/tools/image_generator/README.md
new file mode 100644
index 000000000..22e32f6ce
--- /dev/null
+++ b/tools/image_generator/README.md
@@ -0,0 +1,20 @@
+Recovery Image Generator
+-------------------------
+
+This program uses java.awt.Graphics2D to generate the background text files used
+under recovery mode. And thus we don't need to do the manual work by running
+emulators with different dpi.
+
+# Usage:
+ `java -jar path_to_jar imageWidth textName fontDirectory resourceDirectory outputFilename`
+
+# Description of the parameters:
+1. `imageWidth`: The number of pixels per line; and the text strings will be
+ wrapped accordingly.
+2. `textName`: The description of the text string, e.g. "recovery_erasing",
+ "recovery_installing_security"
+3. `fontDirectory`: The directory that contains all the support .ttf | .ttc
+ files, e.g. $OUT/system/fonts/
+4. `resourceDirectory`: The resource directory that contains all the translated
+ strings in xml format, e.g. bootable/recovery/tools/recovery_l10n/res/
+5. `outputFilename`: Path to the generated image.