Add README for the basic usage

JingMatrix · Dec 7, 2022 · 58faf4f · 58faf4f
1 parent 3232582
commit 58faf4f
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 system/fonts/*.ttf
 system/etc/fonts.xml
+MagiskFonts.zip
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# Magisk
+
+This module configures fonts that you add for system-wise usage.
+
+## Usage
+
+1. Clone this repository: `git clone ---depth 1 https://github.com/JingMatrix/MagiskFonts`;
+2. Create a directory `system/fonts`: `mkdir -p system/fonts`;
+3. Put your fonts inside `system/fonts`, currently `ttf` files work well;
+4. Pack and install the zip module: `7z a MagiskFonts.zip META-INF customize.sh module.prop system tool`.
+
+## Why do I need it?
+
+Add fonts for applications like browsers and e-books readers, such as `Google Play Books`.
diff --git a/module.prop b/module.prop
@@ -3,4 +3,4 @@ name=Costume Fonts
 version=1.0
 versionCode=1
 author=Jing Matrix
-description=Add costume fonts for systemwise usage
+description=Add custom fonts for system-wise usage