From 74b57c8136795e2ac043538bab9a20814f18134c Mon Sep 17 00:00:00 2001 From: Alfi Maulana Date: Fri, 13 Jan 2023 21:53:20 +0700 Subject: [PATCH] add inputs usage in `README.md` --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 9215c5d..8a65f37 100644 --- a/README.md +++ b/README.md @@ -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. |