docs: recommend a depth of 1 for cloning

This commit is contained in:
Daylin Morgan 2023-04-20 16:22:18 -04:00
parent 5961924097
commit c70c84402e
Signed by: daylin
GPG key ID: C1E52E7DD81DF79F

View file

@ -8,13 +8,14 @@ tested w/ MonoLisa v2.003
<img src="./assets/help.svg" width=400> <img src="./assets/help.svg" width=400>
</p> </p>
## Dependencies ## Getting Started
### Dependencies
- `python` - `python`
- `make` (optional) - `make` (optional)
- `fontforge` OR `docker` - `fontforge` OR `docker`
There are some caveats to invoking the `font-patcher` script. There are some caveats to invoking the `font-patcher` script.
Some of which are explained by [nerd fonts](https://github.com/ryanoasis/nerd-fonts#font-patcher). Some of which are explained by [nerd fonts](https://github.com/ryanoasis/nerd-fonts#font-patcher).
To use `font-patcher` with `fontforge` first ensure it is installed (or see below for `docker` approach). To use `font-patcher` with `fontforge` first ensure it is installed (or see below for `docker` approach).
@ -28,6 +29,12 @@ You can also download the version for your system from the releases in the fontf
If you prefer to use `docker` rather than install `fontforge` you can add `ARGS='--docker'` to calls to `make patch`. 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:
```bash
git clone --depth 1 git@github.com:daylinmorgan/monolisa-nerdfont-patch.git
```
## Downloading MonoLisa ## Downloading MonoLisa
Once you have acquired MonoLisa, follow the link in your email to download it. Once you have acquired MonoLisa, follow the link in your email to download it.