From cb46ab8971d82bfe23cbf78efb850dbf5d97bdd7 Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Mon, 23 Jan 2023 14:41:35 +0700 Subject: [PATCH] expand project description --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 420f0ce..c95538e 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ [![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 a [CMake](https://cmake.org/) project on [GitHub Actions](https://github.com/features/actions). +Use this action to simplify the workflow run of your CMake project. +This action will configure a build environment for your project using the `cmake` command, + then it will build your project by running a `cmake --build` command, + and last it could test your project using the `ctest` command. ## Usage