Skip to content

Commit 3a3c559

Browse files
committed
add details to readme to cover Windows use and turning off all font features
1 parent c6af438 commit 3a3c559

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ git clone https://github.com/arrowtype/recursive-code-config.git
5454
cd recursive-code-config
5555
```
5656

57+
##### Using the venv, on macOS (and maybe Linux?)
58+
5759
Then, set up the venv and install requirements:
5860

5961
```bash
@@ -62,6 +64,15 @@ source venv/bin/activate # activate the virtual environment
6264
pip install -r requirements.txt # install dependencies
6365
```
6466

67+
##### Using the venv, on Windows
68+
69+
Setting up the venv and install requirements is slightly different in Windows, in my testing. Navigate to the project in a terminal, and then use the following commands:
70+
71+
```bash
72+
py -m venv venv # make a virtual environment called "venv"
73+
venv\Scripts\activate # activate the virtual environment
74+
pip install -r requirements.txt # install dependencies
75+
```
6576

6677
#### 1. Customize your font settings in `config.yaml`
6778

@@ -95,6 +106,11 @@ Finally, you can copy in the font feature options you want:
95106
96107
![OpenType features](font-data/img/recursive-ot_features.png)
97108
109+
If you want to turn off all features, you can specify an empty array in YAML like this:
110+
111+
```yaml
112+
Features: []
113+
```
98114
99115
#### 2. Build the fonts!
100116

config.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,9 @@ Code Ligatures: True
9494
# Some features (especially "case") will disrupt code ligatures.
9595
# See Issue #20 for more details.
9696

97+
# If you want to turn off all features, you can specify an empty array in YAML like this:
98+
# Features: []
99+
97100
# (Keep the hyphen before each list item)
98101
Features:
99102
- ss01 # Single-story a

0 commit comments

Comments
 (0)