Skip to content

Commit c6af438

Browse files
committed
in readme, clarify how to turn on code ligatures
1 parent cf574c2 commit c6af438

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ The basic way to use this tool is to:
2727
1. Clone the repo and install dependencies (you may wish to fork first, so you can save your preferences to GitHub)
2828
2. Configure your font options in `config.yaml`
2929
3. Run the build script
30+
4. Install the fonts and activate `calt` in your coding app, if you want the code ligatures to be active
3031

3132
This instantiates custom fonts for Regular, Italic, Bold, and Bold Italic styles, which you can then use in your preferred editor. One VS Code theme that supports Italics is the [Recursive Theme](https://github.com/arrowtype/recursive-theme).
3233

@@ -106,6 +107,18 @@ python3 scripts/instantiate-code-fonts.py
106107

107108
It will build & output fonts to a folder like `RecMono-Custom` (this is affected by whatever custom name you give fonts in config.yaml).
108109

110+
#### 3. Install the fonts and activate the ligatures!
111+
112+
This project saves the “code ligatures” to the `calt` feature of fonts, which is the feature most often used by code editors to control code ligatures.
113+
114+
In many apps, the `calt` feature will be on by default. In others, like VS Code, you will need to specifically turn it on.
115+
116+
In VS Code specifically, you can turn on `calt` by adding `fontLigatures` into the `settings.json` file and setting it to `true`:
117+
118+
```JSON
119+
"editor.fontLigatures": true
120+
```
121+
109122
#### Building with other config files
110123

111124
If you wish to build fonts with premade configurations (or reference these), just add their path as an argument (replace `premade-configs/duotone.yaml` below):
@@ -124,8 +137,7 @@ Recursive gets periodic updates, and this repo needs to get these updates, as we
124137

125138
Currently, the process to bring in those updates is pretty simple:
126139

127-
1. Copy the latest variable font (e.g. `Recursive_VF_1.0xx.ttf`) into the `font-data` folder
128-
2. Update the `fontPath` variable in `scripts/instantiate-code-fonts.py` with the latest font path
140+
1. Copy the latest variable font (e.g. `Recursive_VF_1.0xx.ttf`) into the `font-data` folder, and delete the old one
129141
3. Activate the `venv` and run `scripts/build-all.sh <FONTPATH>` to build updated versions of the fonts
130142

131143
Then, you can run the build according to the instructions above.

0 commit comments

Comments
 (0)