Skip to content

Commit 096b976

Browse files
authored
Update README.md
1 parent 140e2fd commit 096b976

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,19 @@ Then it is likely that you need to specify the fortran compiler when you use `ma
7070

7171
For more details, take a look at this [cmake project](https://github.com/coderrect-inc/covid-sim) and [fortran project](https://github.com/coderrect-inc/CloverLeaf_OpenMP) to learn how to integrate Coderrect into more complex projects
7272

73+
### For customized analysis
74+
Coderrect allows you to provide a configuration file to fully customize your analysis.
75+
76+
In order to do so, check our [documentation](https://coderrect.com/documentation/reference/) to see available configurations. Once you write a configuration file (say `coderrect.json`). You can pass it to the scanner as below:
77+
```yaml
78+
- name: coderrect scan
79+
uses: coderrect-inc/[email protected]
80+
with:
81+
options: "-conf=/path/to/coderrect.json"
82+
```
83+
84+
The path should be **a relative path from your build directory** (e.g., if your build directory is `./build/` and your config file is under the root path, then you should specify the option as `options: "-conf=../coderrect.json"`).
85+
7386
## Inputs
7487
- `buildCommand`
7588
- Default: `"make -j"`

0 commit comments

Comments
 (0)