From 559c87b84a03ce5bc2338d51bd5995562338d4c6 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Sat, 5 Dec 2020 11:06:50 +0100 Subject: install: add ‘options’ section, describing compile-time options MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- INSTALL.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md index 40e167a2..45ab5ff1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -7,6 +7,7 @@ 1. [Arch Linux](#arch-linux) 1. [Other](#other) 1. [Setup](#setup) + 1. [Options](#options) 1. [Release build](#release-build) 1. [Size optimized](#size-optimized) 1. [Performance optimized, non-PGO](#performance-optimized-non-pgo) @@ -130,6 +131,15 @@ To build, first, create a build directory, and switch to it: mkdir -p bld/release && cd bld/release ``` +### Options + +All variants below support the following compile-time options: + +| Option | Type | Default | Description | Extra dependencies | +|--------|------|---------|---------------------|--------------------| +| -Dime | Bool | True | Enables IME support | None | + + ### Release build Below are instructions for building foot either [size -- cgit v1.3 From ab699338b3c81e62c6176a5a5be9852050e321e8 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Sat, 5 Dec 2020 11:09:55 +0100 Subject: install: highlight option name in options list --- INSTALL.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md index 45ab5ff1..2afab80e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -135,9 +135,9 @@ mkdir -p bld/release && cd bld/release All variants below support the following compile-time options: -| Option | Type | Default | Description | Extra dependencies | -|--------|------|---------|---------------------|--------------------| -| -Dime | Bool | True | Enables IME support | None | +| Option | Type | Default | Description | Extra dependencies | +|----------|------|---------|---------------------|--------------------| +| `-Dime` | Bool | True | Enables IME support | None | ### Release build -- cgit v1.3 From fe6cf547f15c3f85d97901446c9082aca69af6fe Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Sat, 5 Dec 2020 11:10:29 +0100 Subject: install: highlight option default value in options list --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md index 2afab80e..c370347c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -137,7 +137,7 @@ All variants below support the following compile-time options: | Option | Type | Default | Description | Extra dependencies | |----------|------|---------|---------------------|--------------------| -| `-Dime` | Bool | True | Enables IME support | None | +| `-Dime` | bool | `true` | Enables IME support | None | ### Release build -- cgit v1.3 From 6494ba24c9a37cd792b5f2b9de7170edc4456b5a Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Tue, 8 Dec 2020 19:19:09 +0100 Subject: install: simplify sentence --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md index c370347c..43655b81 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -133,7 +133,7 @@ mkdir -p bld/release && cd bld/release ### Options -All variants below support the following compile-time options: +Available compile-time options: | Option | Type | Default | Description | Extra dependencies | |----------|------|---------|---------------------|--------------------| -- cgit v1.3