From 3a3c559eedb872df51db2918c6f7dcfe9a33432b Mon Sep 17 00:00:00 2001 From: Stephen Nixon Date: Tue, 11 Apr 2023 21:54:49 -0400 Subject: [PATCH] add details to readme to cover Windows use and turning off all font features --- README.md | 16 ++++++++++++++++ config.yaml | 3 +++ 2 files changed, 19 insertions(+) diff --git a/README.md b/README.md index 8423d98..a6d6ef3 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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` @@ -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! diff --git a/config.yaml b/config.yaml index 27e3ce9..1bc2208 100644 --- a/config.yaml +++ b/config.yaml @@ -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