maple-font/README.md
Loc Quan dd04b2607b
Typo/Grammar fixes (#261)
- Fixed majority of grammatical errors (except missing articles)
- Fixed some typos
- Capitalize majority of first letters in sentences for consistency
2024-10-12 23:01:36 +08:00

3.6 KiB

Note

When will V7 become stable?

It is almost stable now.

As a side project during my weekends, I will release a new beta version to fix the bugs reported or encountered in my daily coding within 1-2 weeks, and do some work on the new website and build tools.

If everything goes well, the stable version will be released later this year.

Maple Font (WIP)

Open source monospace & nerd font with round corner and ligatures.

Based on JetBrains Mono and much "Opinioned"

Features

  • Round corner
  • New shape of @ $ % & Q a and cursive italic f i j k l x y
  • Large amount of ligatures
    • equal variants: == / === / != / !== / >= / <=...
    • arrow variants: -> / => / --> / ==> / <-> / <=>...
    • xml variants: </ / /> / <> / </> / <!--...
    • flow variants: |> / ||> / |||> / |||> / >=> / =>>...
    • same characters: ++ / -- / && / || / !! / ?? / .. / :: / ########...
    • plain text tag: [TODO] / todo)) / [FIXME] / fixme))
      • for logger: [TRACE] / [DEBUG] / [INFO] / [WARN] / [ERROR] / [FATAL]
  • Font features
    • zero: Dot style 0
    • cv01: Classic @ / $ / % / & / Q / => / ->
    • cv02: Alternative a (with top alarm)
    • cv03: Alternative i (without bottom left bar)
    • cv04: Alternative l (with bottom left bar) and 1 (without bottom bar)
    • cv98: Full width (ellipsis) and (emdash) support for Maple Mono NF CN
    • cv99: Traditional punctuation support for Maple Mono NF CN
    • ss01: Non-cursive italic style l i j k x
    • ss02: Disable ligatures on equals like == / != / <=
    • ss03: Ignore cases on all tags
    • ss04: Disable ligatures on __, #__, \n

Build

Clone the repo and run on your local machine. Make sure you have python3 and pip installed

git clone https://github.com/subframe7536/maple-font --depth 1 -b variable
pip install foundrytools-cli
python build.py
  • For Ubuntu or Debian, maybe python-is-python3 is needed as well

If you have trouble installing the dependencies, just create a new Github codespace on variable branch and run the commands there

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

Chinese version

  1. Download CN base font at Gitee release
  2. Put them into ./source/cn
  3. Run build.py and BE PATIENT, instantiation will take about 30 minutes

Release Build

python build.py --release

Credit

License

SIL Open Font License 1.1