From f2c79a9acdfb7ac56a56cc601d9a7c6c372b319a Mon Sep 17 00:00:00 2001
From: subframe7536 <1667077010@qq.com>
Date: Sun, 8 Dec 2024 14:01:57 +0800
Subject: [PATCH] more details in custom build section

---
 .github/workflows/custom.yml |  2 +-
 README.md                    | 19 ++++++++++++-------
 2 files changed, 13 insertions(+), 8 deletions(-)

diff --git a/.github/workflows/custom.yml b/.github/workflows/custom.yml
index 459941b..e824b5a 100755
--- a/.github/workflows/custom.yml
+++ b/.github/workflows/custom.yml
@@ -1,4 +1,4 @@
-name: Custom Build Font
+name: Custom Build
 
 on:
   workflow_dispatch:
diff --git a/README.md b/README.md
index 9b922e8..8826c2f 100644
--- a/README.md
+++ b/README.md
@@ -69,9 +69,13 @@ paru -S ttf-maple-beta
 
 ## Custom Build
 
-### Github Actions
+The [`config.json`](./config.json) file is used to configure the build process. Checkout the [schema](./source/schema.json) for more details.
 
-You can use [Github Actions](https://github.com/subframe7536/maple-font/actions) to build the font.
+There also have some command line options for customizing the build process. Cli options have higher priority than `config.json`.
+
+### Use Github Actions
+
+You can use [Github Actions](https://github.com/subframe7536/maple-font/actions/workflows/custom.yml) to build the font.
 
 1. Fork the repo
 2. (Optional) Change the content in `config.json`
@@ -81,7 +85,7 @@ You can use [Github Actions](https://github.com/subframe7536/maple-font/actions)
 6. Wait for the build to finish
 7. Download the font archives from Releases
 
-### Docker
+### With Docker
 
 ```shell
 git clone https://github.com/subframe7536/maple-font --depth 1 -b variable
@@ -89,7 +93,7 @@ docker build -t maple-font .
 docker run -v "$(pwd)/fonts:/app/fonts" -e BUILD_ARGS="--normal" maple-font
 ```
 
-### Local
+### Local Build
 
 Clone the repo and run on your local machine. Make sure you have `python3` and `pip` installed
 
@@ -103,10 +107,11 @@ python build.py
 
 If you have trouble installing the dependencies, just create a new Github codespace on `variable` branch and run the commands there
 
-### Options
+#### Custom Nerd-Font
 
-You can change build config in `config.json`
-- For custom `font-patcher` args, `font-forge` (and maybe `python3-fontforge` as well) is needed
+For custom `font-patcher` args, `font-forge` (and maybe `python3-fontforge` as well) is required.
+
+You should also change `nerd_font` config in `config.json`
 
 #### Preset