From 2cc4597ac233f3ca4820e1b92d8e4d87fe288855 Mon Sep 17 00:00:00 2001 From: Mike Dalessio Date: Sun, 22 Oct 2023 11:08:41 -0400 Subject: [PATCH] doc: update README with cmake_build_type documentation --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7825f7..6642e53 100644 --- a/README.md +++ b/README.md @@ -138,8 +138,8 @@ This is configurable as above, except for Windows systems where it's hardcoded t The cmake command used is configurable, and in order of preference will use: - the `CMAKE` environment variable (if present) -- the `cmake_command` value passed in to the constructor -- `"cmake"` +- the `:cmake_command` keyword argument passed into the constructor +- `"cmake"` (the default) You can pass it in like so: @@ -147,6 +147,19 @@ You can pass it in like so: MiniPortileCMake.new("libfoobar", "1.3.5", cmake_command: "cmake3") ``` +#### `cmake_build_type` + +The cmake build type is configurable as of v2.8.5, and in order of preference will use: + +- the `CMAKE_BUILD_TYPE` environment variable (if present) +- the `:cmake_build_type` keyword argument passed into the constructor +- `"Release"` (the default) + +You can pass it in like so: + +``` ruby +MiniPortileCMake.new("libfoobar", "1.3.5", cmake_build_type: "Debug") +``` ### Local source directories