Skip to content

Commit

Permalink
chore: merge pull request #51 from threeal/docs-fix-example
Browse files Browse the repository at this point in the history
Adjust and Fix Examples in the Readme
  • Loading branch information
threeal authored Jun 30, 2023
2 parents 6990120 + 735354b commit 555658b
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,31 +65,30 @@ jobs:
> **Note**: You can replace [`v1.2.0`](https://github.com/threeal/cmake-action/releases/tag/v1.2.0) with any version you prefer. See [this](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses).

#### Specify the Source and Build Directories
#### Configure, Build, and Test in the Same Step

```yaml
- name: Configure the project
- name: Configure, build, and test the project
uses: threeal/cmake-action@v1.2.0
with:
source-dir: submodules
build-dir: submodules/out
run-build: true
run-test: true
```

#### Configure, Build, and Test in the Same Step
#### Specify the Source and Build Directories

```yaml
- name: Configure, build, and test the project
- name: Configure the project
uses: threeal/cmake-action@v1.2.0
with:
options: BUILD_TESTING=ON
run-build: true
run-test: true
source-dir: submodules
build-dir: submodules/out
```

#### Using Ninja as the Generator and Clang as the Compiler

```yaml
- name: Configure and build the project
- name: Configure the project
uses: threeal/cmake-action@v1.2.0
with:
generator: Ninja
Expand Down

0 comments on commit 555658b

Please # to comment.