Skip to content

Commit

Permalink
Corected README.
Browse files Browse the repository at this point in the history
  • Loading branch information
cpp977 committed Mar 10, 2022
1 parent 14a8503 commit fb27cf0
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# GenCMakeDoc
Generates documentation of all cmake build options for a cmake based project directly into the project's README

## Inputs
# Inputs

## `source_dir`

Expand All @@ -10,9 +10,11 @@ Generates documentation of all cmake build options for a cmake based project dir
## `option_filter`
Specify a filter for cmake options to process. For getting options like `MYLIB_SOME_OPT`, set filter to `"MYLIB"`. If empty, no filter is applied. Default `""`.

## Example usage
# Example usage

```
uses: actions/GenCMakeDoc@v0
with:
source_dir: $GITHUB_WORKSPACE
option_filter: MYPROJECT
```

0 comments on commit fb27cf0

Please sign in to comment.