mirror of https://github.com/daylinmorgan/monolisa-nerdfont-patch.git synced 2024-12-21 22:40:44 -06:00

Patch MonoLisa with Nerd Fonts

Find a file

Daylin Morgan 063aefe4d8 Revert "chore: change batteries" This reverts commit `5b946b0aca`.		2023-05-02 14:31:31 -05:00
.github/workflows	ci: add change batteries cron job	2023-01-16 12:44:35 -06:00
assets	docs: update help.svg	2023-01-29 21:57:17 -06:00
bin	Revert "chore: change batteries"	2023-05-02 14:31:31 -05:00
MonoLisa	add gitignore and needed subfolders	2021-11-09 11:51:56 -06:00
patched	add gitignore and needed subfolders	2021-11-09 11:51:56 -06:00
src/glyphs	Revert "chore: change batteries"	2023-05-02 14:31:31 -05:00
.flake8	feat: find is dead long live python	2022-12-11 17:36:50 -06:00
.gitignore	add sourcing of .env	2022-12-13 00:27:51 -06:00
.pre-commit-config.yaml	build: drop flake8 for ruff and update pre-commit repos	2023-03-20 01:40:55 -05:00
.task.cfg.mk	build: bump task.mk version again	2023-01-29 21:57:06 -06:00
.task.mk	build: bump task.mk version again	2023-01-29 21:57:06 -06:00
LICENSE	chore: add licensing info	2023-03-20 01:40:35 -05:00
Makefile	fix(#4 ): refactor to reduce some boilerplate	2023-03-20 01:40:55 -05:00
patch-monolisa	fix(#4 ): refactor to reduce some boilerplate	2023-03-20 01:40:55 -05:00
README.md	docs: recommend a depth of 1 for cloning	2023-04-20 16:22:26 -04:00

README.md

MonoLisa NF

Most Batteries included repo to patch MonoLisa with Nerd Fonts glyphs

tested w/ MonoLisa v2.003

Getting Started

Dependencies

python
make (optional)
fontforge OR docker

There are some caveats to invoking the font-patcher script. Some of which are explained by nerd fonts. To use font-patcher with fontforge first ensure it is installed (or see below for docker approach).

On Arch:

sudo pacman -S fontforge

You can also download the version for your system from the releases in the fontforge repo.

If you prefer to use docker rather than install fontforge you can add ARGS='--docker' to calls to make patch.

Next you may clone the repo to fetch the needed symbols/scripts for patching:

git clone --depth 1 git@github.com:daylinmorgan/monolisa-nerdfont-patch.git

Downloading MonoLisa

Once you have acquired MonoLisa, follow the link in your email to download it. Then extract the .zip file of the type you've downloaded into MonoLisa/.

The expected directory structure is below. You only need to download the font types you plan to use.

MonoLisa
├── otf
├── ttf
├── woff
└── woff2

Patching your font

Once you have downloaded MonoLisa and fontforge you can easily apply the nerd font patches with make.

To patch all font types use the default patch rule.

make # or ./patch-monolisa -f MonoLisa -c

By default the complete (-c) flag is passed to the font-patcher script to include all icons/symbols. You can change this by specifying the ARGS at runtime.

ARGS="-c -w" make patch

See ./patch-monolisa --help and ./bin/font-patcher --help for available ARGS.

You can find your patched fonts in the patched/ directory

If like me you want to place your patched fonts in a standard location on your Unix system you can move them to ~/.local/share/fonts/MonoLisa with the bin/update-fonts script.

Or for simplicity you can copy the fonts and update the cache with:

make update-fonts

You can verify the fonts have been added with make check.

Contributing

Before making changes to to any of the scripts in bin you should first install pre-commit. Followed by setting up the pre-commit hooks locally.

pipx install pre-commit
pre-commit install