You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,6 +27,7 @@ The basic way to use this tool is to:
27
27
1. Clone the repo and install dependencies (you may wish to fork first, so you can save your preferences to GitHub)
28
28
2. Configure your font options in `config.yaml`
29
29
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
30
31
31
32
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).
It will build & output fonts to a folder like `RecMono-Custom` (this is affected by whatever custom name you give fonts in config.yaml).
108
109
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
+
109
122
#### Building with other config files
110
123
111
124
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
124
137
125
138
Currently, the process to bring in those updates is pretty simple:
126
139
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
129
141
3. Activate the `venv` and run `scripts/build-all.sh <FONTPATH>` to build updated versions of the fonts
130
142
131
143
Then, you can run the build according to the instructions above.
0 commit comments