From fc5e82e9e08d1869287cc25821f14fe92d8eef13 Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Fri, 30 Jun 2023 12:44:02 +0700 Subject: [PATCH] docs: describe how each inputs append the CMake arguments --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 143dbd4..5781e0e 100644 --- a/README.md +++ b/README.md @@ -24,21 +24,21 @@ For more information, refer to [action.yml](./action.yml) and the [GitHub Action | --- | --- | --- | | `source-dir` | Path | The source directory of the CMake project. It defaults to the current directory. | | `build-dir` | Path | The build directory of the CMake project. It defaults to the `build` directory inside the source directory. | -| `generator` | String | The build system generator for the CMake project. | -| `c-compiler` | String | The preferred executable for compiling C language files. | -| `cxx-compiler` | String | The preferred executable for compiling C++ language files. | -| `c-flags` | Multiple strings | Additional flags to pass when compiling C language files. | -| `cxx-flags` | Multiple strings | Additional flags to pass when compiling C++ language files. | -| `options` | Multiple strings | Additional options to pass during the CMake configuration. | +| `generator` | String | The build system generator for the CMake project. It appends the CMake configuration arguments with `-G [val]`. | +| `c-compiler` | String | The preferred executable for compiling C language files. It appends the CMake configuration arguments with `-D CMAKE_C_COMPILER=[val]`. | +| `cxx-compiler` | String | The preferred executable for compiling C++ language files. It appends the CMake configuration arguments with `-D CMAKE_CXX_COMPILER=[val]`. | +| `c-flags` | Multiple strings | Additional flags to pass when compiling C language files. It appends the CMake configuration arguments with `-D CMAKE_C_FLAGS=[vals]`. | +| `cxx-flags` | Multiple strings | Additional flags to pass when compiling C++ language files. It appends the CMake configuration arguments with `-D CMAKE_CXX_FLAGS=[vals]`. | +| `options` | Multiple strings | Additional options to pass during the CMake configuration. It appends the CMake configuration arguments with each of `-D [val]`. | | `args` | Multiple strings | Additional arguments to pass during the CMake configuration. | -| `run-build` | `true` or `false` | If enabled, it builds the project using [CTest](https://cmake.org/cmake/help/latest/manual/ctest.1.html). It defaults to `false`. | +| `run-build` | `true` or `false` | If enabled, it builds the project using CMake. It defaults to `false`. | | `build-args` | Multiple strings | Additional arguments to pass during the CMake build. | | `run-test` | `true` or `false` | If enabled, it runs testing using [CTest](https://cmake.org/cmake/help/latest/manual/ctest.1.html). It defaults to `false`. | | `test-args` | Multiple strings | Additional arguments to pass during the CTest run. | -> Note: Multiple strings mean that the input can be specified with more than one value. Separate each value with a space or a new line. +> **Note**: Multiple strings mean that the input can be specified with more than one value. Separate each value with a space or a new line. -> Note: All inputs are optional. +> **Note**: All inputs are optional. ### Examples @@ -63,7 +63,7 @@ jobs: runs: ctest --test-dir build ``` -> Note: You can replace `@latest` with any version you prefer. See [this](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses). +> **Note**: You can replace `@latest` with any version you prefer. See [this](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses). #### Specify the Source and Build Directories