actions/cmake-action
1
0
Fork 0
mirror of https://github.com/threeal/cmake-action.git synced 2025-07-27 08:14:23 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs(readme): shift usage section and remove a paragraph

Browse Source
This commit is contained in:
Alfi Maulana 2024-08-04 23:18:31 +07:00
parent a30bc871ed
commit 388e7572c7
No known key found for this signature in database
GPG Key ID: 2242A64C2A8DF5A4
1 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -4,11 +4,7 @@ Configure and build [CMake](https://cmake.org/) projects on [GitHub Actions](htt
This action wraps the [`cmake`](https://cmake.org/cmake/help/latest/manual/cmake.1.html) command for configuring and building CMake projects. It provides a more streamlined syntax for specifying build options compared to calling the `cmake` command directly. This action wraps the [`cmake`](https://cmake.org/cmake/help/latest/manual/cmake.1.html) command for configuring and building CMake projects. It provides a more streamlined syntax for specifying build options compared to calling the `cmake` command directly.
## Usage ## Available Inputs
For more information, refer to [action.yml](./action.yml) and the [GitHub Actions guide](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions).
### Inputs
| Name | Value Type | Description | | Name | Value Type | Description |
| --- | --- | --- | | --- | --- | --- |
@ -28,13 +24,13 @@ For more information, refer to [action.yml](./action.yml) and the [GitHub Action
> **Note**: All inputs are optional. > **Note**: All inputs are optional.
### Outputs ## Available Outputs
| Name | Value Type | Description | | Name | Value Type | Description |
| --- | --- | --- | | --- | --- | --- |
| `build-dir` | Path | The build directory of the CMake project. | | `build-dir` | Path | The build directory of the CMake project. |
### Examples ## Example Usages
```yaml ```yaml
name: Build name: Build
@ -54,7 +50,7 @@ jobs:
> **Note**: You can replace `main` 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 `main` with any version you prefer. See [this](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses).
#### Configure Project Without Building ### Configure Project Without Building
```yaml ```yaml
- name: Configure Project - name: Configure Project
@ -63,7 +59,7 @@ jobs:
run-build: false run-build: false
``` ```
#### Specify the Source and Build Directories ### Specify the Source and Build Directories
```yaml ```yaml
- name: Configure and Build Project - name: Configure and Build Project
@ -73,7 +69,7 @@ jobs:
build-dir: submodules/out build-dir: submodules/out
``` ```
#### Using Ninja as the Generator and Clang as the Compiler ### Using Ninja as the Generator and Clang as the Compiler
```yaml ```yaml
- name: Setup Ninja - name: Setup Ninja