Skip to content

Commit 140e2fd

Browse files
authored
Add syntax highlighting and small textual changes
1 parent 8717b8e commit 140e2fd

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,22 @@ Check [here](https://github.com/funemy/memcached/blob/master/.github/workflows/c
2020
In general, integrating Coderrect requires two steps:
2121

2222
1. Install all dependencies required to build your project:
23-
```
23+
```yaml
2424
- name: Install deps
2525
run: |
2626
sudo apt-get update -y
2727
sudo apt-get install -y libevent-dev libseccomp-dev git libsasl2-dev
2828
```
2929
3030
2. Apply Coderrect Github Action
31-
```
31+
```yaml
3232
- name: Coderrect Scan
3333
uses: coderrect-inc/[email protected]
3434
```
3535
3636
### For CMake projects
3737
You will need to install and setup `cmake` first.
38-
```
38+
```yaml
3939
- name: download cmake
4040
run: |
4141
wget https://cmake.org/files/v3.18/cmake-3.18.2-Linux-x86_64.tar.gz
@@ -45,7 +45,7 @@ You will need to install and setup `cmake` first.
4545
```
4646
Since we are building the project under the `build` directory instead of the root path.
4747
We will also need to specify the build directory for Coderrect.
48-
```
48+
```yaml
4949
- name: Coderrect Scan
5050
uses: coderrect-inc/[email protected]
5151
with:
@@ -54,14 +54,14 @@ We will also need to specify the build directory for Coderrect.
5454

5555
### For Fortran projects
5656
You will need to install the fortran compiler first. For example:
57-
```
57+
```yaml
5858
- name: Install fortran
5959
run: |
6060
sudo apt-get update -y
6161
sudo apt-get install -y gfortran
6262
```
6363
Then it is likely that you need to specify the fortran compiler when you use `make`. If so, you should also pass the full compilation command to Coderrect. (`gcc` is pre-installed in the Github Action environment.)
64-
```
64+
```yaml
6565
- name: coderrect scan
6666
uses: coderrect-inc/[email protected]
6767
with:
@@ -76,7 +76,7 @@ For more details, take a look at this [cmake project](https://github.com/coderre
7676
- Description: The command to build your project. For example, the command to build your whole project might be `make all` instead of `make`.
7777
- `cleanCommand`
7878
- Default: `"make clean"`
79-
- 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.
79+
- Description: The command to clean your previous build. Coderrect needs to capture the building process for analysis, therefore if you have done a test build before applying Coderrect, we need to clean your test build first.
8080
- `buildPath`
8181
- Default: `"."`
8282
- Description: The relative path for your cmake project's build directory.

0 commit comments

Comments
 (0)