From 7ea5604d56206b0693ba3917b3cde4bcd18b25a6 Mon Sep 17 00:00:00 2001
From: subframe7536 <1667077010@qq.com>
Date: Sun, 8 Dec 2024 00:09:58 +0800
Subject: [PATCH] add namingFAQ

---
 .github/release_template.md |  2 ++
 README.md                   | 39 +++++++++++++++++++++++++++++++++----
 2 files changed, 37 insertions(+), 4 deletions(-)

diff --git a/.github/release_template.md b/.github/release_template.md
index 2dcc9c0..d56ef19 100644
--- a/.github/release_template.md
+++ b/.github/release_template.md
@@ -1,3 +1,5 @@
+[Which File to Download?](https://github.com/subframe7536/maple-font/tree/variable?tab=readme-ov-file#naming-faq)
+
 | Format   | Ligature                                                                                             | No-Ligature                                                                                              | Normal-Ligature                                                                                                  | Normal-No-Ligature                                                                                                   |
 | -------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
 | Variable | [unhinted](https://<url>/MapleMono-Variable.zip)                                                     | [unhinted](https://<url>/MapleMonoNL-Variable.zip)                                                       | [unhinted](https://<url>/MapleMonoNormal-Variable.zip)                                                           | [unhinted](https://<url>/MapleMonoNormalNL-Variable.zip)                                                             |
diff --git a/README.md b/README.md
index 6cf9e5d..e6b1557 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,8 @@ Maple Mono is an open source monospace font focused on smoothing your coding exp
 
 I create it to enhance my working experience, and hope that it can be useful to others.
 
+You can checkout old version [here](https://github.com/subframe7536/maple-font/tree/main)
+
 ## Features
 
 - ✨ Variable - Infinity font weights with fine-grained italic glyphs.
@@ -27,7 +29,34 @@ I create it to enhance my working experience, and hope that it can be useful to
 - Generated by [CodeImg](https://github.com/subframe7536/vscode-codeimg)
 - Theme: [Maple](https://github.com/subframe7536/vscode-theme-maple)
 
-## Build
+## Naming FAQ
+
+### Features
+
+- **Ligature**: Default version with ligatures
+- **No-Ligature**: Default version without ligatures
+- **Normal-Ligature**: [`--normal` preset](#preset) with ligatures
+- **Normal-No-Ligature**: [`--normal` preset](#preset) without ligatures
+
+### Format and Glyph Set
+
+- **Variable**: Minimal version, smoothly change font weight by variable
+- **TTF**: Minimal version, ttf format [Recommend!]
+- **TTF-AutoHint**: Minimal version, ttf format with hint, better for low resolution monitor
+- **OTF**: Minimal version, otf format
+- **WOFF2**: Minimal version, woff2 format, for small size on web pages
+- **NF**: Nerd-Font patched version, add icons for terminal
+- **CN**: Chinese version, embed with Chinese and Japanese glyphs
+- **NF-CN**: Full version, embed with icon, Chinese and Japanese glyphs
+
+### Font Hint
+
+- *`hinted font`* is used for low resolution screen to have better render effect. From my experience, if your screen resolution is lower or equal than 1080P, it is recommended to use "hinted font".
+  - In this case, you can choose `MapleMono-TTF-AutoHint` / `MapleMono-NF` / `MapleMono-NF-CN`, etc.
+- *`unhinted font`* is used for high resolution screen (e.g. for Mac), when using "hinted font", it will blur your text or make it looks weird.
+  - In this case, you can choose `MapleMono-OTF` / `MapleMono-TTF` / `MapleMono-NF-unhinted` / `MapleMono-NF-CN-unhinted`, etc.
+
+## Custom Build
 
 Clone the repo and run on your local machine. Make sure you have `python3` and `pip` installed
 
@@ -44,10 +73,12 @@ If you have trouble installing the dependencies, just create a new Github codesp
 ### Customize
 
 You can change build config in `config.json`
-
-- There is `--normal` option in `build.py` for common config, just like `JetBrains Mono` (with slashed zero)
 - For custom `font-patcher` args, `font-forge` (and maybe `python3-fontforge` as well) is needed
 
+#### Preset
+
+Add `--normal` flag in `build.py` for common config, make the font just like `JetBrains Mono` (with slashed zero).
+
 #### Font Feature Freeze Options
 
 - `enable`: Move ligature rules to `calt`, which will enable the features without setting up `cvXX` / `ssXX` / `zero` in font features config, just as default ligatures
@@ -56,7 +87,7 @@ You can change build config in `config.json`
 
 ### Chinese version
 
-Run `python build.py --cn`, the CN base fonts (about 135 MB) will download from remote.
+Run `python build.py --cn`, the CN base fonts (about 135 MB) will download from GitHub.
 
 If you want to build CN base fonts from variable (about 35 MB), setup `"cn.use_static_base_font": false` in [config.json](./config.json) and **BE PATIENT**, instantiation will take about 40-50 minutes.