docs: improve readme documentation (#386)

* docs(readme): improve project description

* docs(readme): remove unnecessary features section

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

* docs(readme): improve available inputs and outputs section

* docs(readme): improve example usages section

* docs: update descriptions in `action.yml`
This commit is contained in:
Alfi Maulana
2024-08-05 09:57:10 +07:00
committed by GitHub
parent 204a23d513
commit 51d21ca665
2 changed files with 58 additions and 50 deletions

View File

@@ -1,5 +1,5 @@
name: CMake Action
description: Configure and build your CMake project
description: Configure and build CMake projects
author: Alfi Maulana
branding:
color: gray-dark
@@ -24,7 +24,7 @@ inputs:
args:
description: Additional arguments to pass during the CMake configuration
run-build:
description: If enabled, it builds the project using CMake (true/false)
description: If enabled, builds the project using CMake
default: true
build-args:
description: Additional arguments to pass during the CMake build