Skip to content

Commit

Permalink
add details to readme to cover Windows use and turning off all font f…
Browse files Browse the repository at this point in the history
…eatures
  • Loading branch information
arrowtype committed Apr 12, 2023
1 parent c6af438 commit 3a3c559
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ git clone https://github.com/arrowtype/recursive-code-config.git
cd recursive-code-config
```

##### Using the venv, on macOS (and maybe Linux?)

Then, set up the venv and install requirements:

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

##### Using the venv, on Windows

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:

```bash
py -m venv venv # make a virtual environment called "venv"
venv\Scripts\activate # activate the virtual environment
pip install -r requirements.txt # install dependencies
```

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

Expand Down Expand Up @@ -95,6 +106,11 @@ Finally, you can copy in the font feature options you want:
![OpenType features](font-data/img/recursive-ot_features.png)
If you want to turn off all features, you can specify an empty array in YAML like this:
```yaml
Features: []
```
#### 2. Build the fonts!
Expand Down
3 changes: 3 additions & 0 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ Code Ligatures: True
# Some features (especially "case") will disrupt code ligatures.
# See Issue #20 for more details.

# If you want to turn off all features, you can specify an empty array in YAML like this:
# Features: []

# (Keep the hyphen before each list item)
Features:
- ss01 # Single-story a
Expand Down

0 comments on commit 3a3c559

Please sign in to comment.