actions/cmake-action
1
0
Fork 0
mirror of https://github.com/threeal/cmake-action.git synced 2025-04-20 02:31:20 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

add inputs usage in README.md

Browse Source
This commit is contained in:
Alfi Maulana 2023-01-13 21:53:20 +07:00
parent a6e04c0edd
commit 74b57c8136
No known key found for this signature in database
GPG Key ID: 2242A64C2A8DF5A4
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -5,3 +5,21 @@
[![test status](https://img.shields.io/github/actions/workflow/status/threeal/cmake-action/test.yml?label=test&branch=main)](https://github.com/threeal/cmake-action/actions/workflows/test.yml)
Configure and build [CMake](https://cmake.org/) project on [GitHub Actions](https://github.com/features/actions).
## Usage
For more information, see [action.yml](./action.yml) and [GitHub Actions guide](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions).
### Inputs
> Note: All inputs are optional.
| Name | Value Type | Description |
| --- | --- | --- |
| `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. |
| `targets` | Multiple strings | List of build targets. Could be specified more than one. Separate each target with a space or a new line. |
| `generator` | String | Build system generator of the CMake project. |
| `c-compiler` | String | Preferred executable for compiling C language files. |
| `cxx-compiler` | String | Preferred executable for compiling CXX 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. |