Skip to content

Commit

Permalink
doc: update README with cmake_build_type documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
flavorjones committed Oct 22, 2023
1 parent 59c9196 commit 2cc4597
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,15 +138,28 @@ 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:

``` ruby
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

Expand Down

0 comments on commit 2cc4597

Please sign in to comment.