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

docs: improve the description and features section in the readme file

Browse Source
This commit is contained in:
Alfi Maulana 2023-07-02 22:09:25 +07:00
parent 19d48ebea6
commit 9d9c70d257
No known key found for this signature in database
GPG Key ID: 2242A64C2A8DF5A4
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -4,15 +4,15 @@
[![License](https://img.shields.io/github/license/threeal/cmake-action)](./LICENSE) [![License](https://img.shields.io/github/license/threeal/cmake-action)](./LICENSE)
[![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) [![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, build, and test your [CMake](https://cmake.org/) project using [GitHub Actions](https://github.com/features/actions). This action simplifies the workflow for your CMake project. It configures the build environment using the `cmake` command, and optionally builds the project using the `cmake --build` command and tests the project using the `ctest` command. Configure, build, and test your [CMake](https://cmake.org/) project using [GitHub Actions](https://github.com/features/actions). This action simplifies the workflow for configuring the build environment of a CMake project. It can also be optionally specified to build a CMake project using the `cmake --build` command and test it using the `ctest` command.
## Features ## Features
- Configures a project using the [`cmake`](https://cmake.org/cmake/help/latest/manual/cmake.1.html) command. - Configures a CMake project using the [`cmake`](https://cmake.org/cmake/help/latest/manual/cmake.1.html) command.
- Option to build a project using the `cmake --build` command. - Optionally builds a CMake project using the `cmake --build` command.
- Option to test a project using the [`ctest`](https://cmake.org/cmake/help/latest/manual/ctest.1.html) command. - Optionally tests a CMake project using the [`ctest`](https://cmake.org/cmake/help/latest/manual/ctest.1.html) command.
- Auto-detects and installs required dependencies. - Auto-detects and installs required dependencies.
- Supports specifying multiple CMake options directly from the Action inputs. - Supports specifying multiple CMake options directly from the action inputs.
## Usage ## Usage

2
action.yml
View File

@ -1,5 +1,5 @@
name: CMake Action name: CMake Action
description: Configure, build, and test a CMake project description: Configure, build, and test your CMake project
author: Alfi Maulana author: Alfi Maulana
branding: branding:
color: gray-dark color: gray-dark