maple-font/README.md
2024-07-27 17:33:15 +08:00

81 lines
2.8 KiB
Markdown

# 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.
Base on `Jetbrains Mono` and **much "Opinioned"**
![](https://github.com/subframe7536/maple-font/assets/78338239/19383849-6be1-4cfc-9b34-7b33fc047ecf)
- generated by [CodeImg](https://github.com/subframe7536/vscode-codeimg)
- Theme: [Maple](https://github.com/subframe7536/vscode-theme-maple)
## 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: normal `@ $ & Q => ->`
- cv02: normal `a`
- cv03: alternative `i`
- cv04: alternative `l` and `1` (for better differentiation)
- cv98: full width `…`(ellipsis) and `—`(emdash) support for Maple Mono NF CN
- cv99: TW punctuations support for Maple Mono NF CN
- ss01: normal italic `f l i j x y`
- ss02: split `==` / `===` / `!=` / `!==` / `=/=` / `>=` / `<=`
- ss03: arbitrary plain text tags
- ss04: normal `__` / `#__` / `***`
## Build
### Browser
WIP
### Local
run it in your local machine.
You can change config in `config.json`
Make sure you have `python3` and `pip` installed
- for custom `font-patcher` args, `font-forge` (and maybe `python3-fontforge` as well) is needed
- for `Ubuntu` or `Debian`, maybe `python-is-python3` is needed as well
```shell
pip install foundrytools-cli
python build.py
```
If you have trouble to install the dependencies, just create a new Github codespace on `variable` branch and run the commands there
## credit
- [Jetbrains Mono](https://github.com/JetBrains/JetBrainsMono)
- [Roboto Mono](https://github.com/googlefonts/RobotoMono)
- [Fira Code](https://github.com/tonsky/FiraCode)
- [Victor Mono](https://github.com/rubjo/victor-mono)
- [Commit Mono](https://github.com/eigilnikolajsen/commit-mono)
- [Code Sample](https://github.com/TheRenegadeCoder/sample-programs-website)
- [Nerd Font](https://github.com/ryanoasis/nerd-fonts)
## License
SIL Open Font License 1.1