Skip to content

Commit 75bad2e

Browse files
authored
Update README.md
1 parent d200782 commit 75bad2e

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@ Please find more information in our official website: [Coderrect.com](coderrect.
2121
```
2222
Take a look at this [cmake project](https://github.com/coderrect-inc/CloverLeaf_OpenMP) and [fortran project](https://github.com/coderrect-inc/covid-sim ) to learn how to integrate Coderrect into more complex projects
2323

24+
## Inputs
25+
- `buildCommand`
26+
- Default: `"make -j"`
27+
- Description: The command to build your project. For example, the task to build your whole project might be `make all` instead of `make`.
28+
- `cleanCommand`
29+
- Default: `"make clean"`
30+
- Description: The command to clean your previous build. Coderrect need to capture the building process of your project for analysis, therefore if your have a test build before applying Coderrect, we need to clean your test build.
31+
- `buildPath`
32+
- Default: `"build"`
33+
- Description: The relative path for your cmake project's build directory.
34+
- `options`
35+
- Default: `"-analyzeAllBinaries"`
36+
- Description: The command line options for Coderrect Scanner. Check the (documentation)[https://coderrect.com/documentation/reference/] for all supported options.
37+
2438
## License
2539
Copyright 2020 Coderrect Inc.
2640

0 commit comments

Comments
 (0)