actions/cmake-action
1
0
Fork 0
mirror of https://github.com/threeal/cmake-action.git synced 2025-06-08 10:11:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

convert multiple strings description in inputs usage section to be a note

Browse Source
This commit is contained in:
Alfi Maulana 2023-01-14 19:46:26 +07:00
parent 47e602f22e
commit 14c5b01b37
No known key found for this signature in database
GPG Key ID: 2242A64C2A8DF5A4
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -12,19 +12,21 @@ For more information, see [action.yml](./action.yml) and [GitHub Actions guide](
### Inputs ### Inputs
> Note: All inputs are optional.
| Name | Value Type | Description | | Name | Value Type | Description |
| --- | --- | --- | | --- | --- | --- |
| `source-dir` | Path | Source directory of the CMake project. Defaults to current directory. | | `source-dir` | Path | Source directory of the CMake project. Defaults to current directory. |
| `build-dir` | Path | Build directory of the CMake project. Defaults to `build` directory in current directory. | | `build-dir` | Path | Build directory of the CMake project. Defaults to `build` directory in current directory. |
| `targets` | Multiple strings | List of build targets. Could be specified more than one. Separate each target with a space or a new line. | | `targets` | Multiple strings | List of build targets. |
| `generator` | String | Build system generator of the CMake project. | | `generator` | String | Build system generator of the CMake project. |
| `c-compiler` | String | Preferred executable for compiling C language files. | | `c-compiler` | String | Preferred executable for compiling C language files. |
| `cxx-compiler` | String | Preferred executable for compiling C++ language files. | | `cxx-compiler` | String | Preferred executable for compiling C++ language files. |
| `c-flags` | Multiple strings | Additional flags passed when compiling C language files. Could be specified more than one. Separate each flag with a space or a new line. | | `c-flags` | Multiple strings | Additional flags passed when compiling C language files. |
| `cxx-flags` | Multiple strings | Additional flags passed when compiling C++ language files. Could be specified more than one. Separate each flag with a space or a new line. | | `cxx-flags` | Multiple strings | Additional flags passed when compiling C++ language files. |
| `args` | Multiple strings | Additional arguments passed during the CMake configuration. Could be specified more than one. Separate each target with a space or a new line. | | `args` | Multiple strings | Additional arguments passed during the CMake configuration. |
> Note: Multiple strings mean that the input could be specified with more than one value. Separate each value with a space or a new line.
> Note: All inputs are optional.
### Examples ### Examples