Skip to content

Commit dfe9beb

Browse files
committed
fixing typo and adding guidelines to install from source code
1 parent e62cbea commit dfe9beb

2 files changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SECOMlint
22

3-
Linter to measure compliance against [SECOM](https://tqrg.github.io/secom/) convention. SECOM is a convetion for making security commit messages more readable and structured. Check the [CONFIG.md](https://github.com/TQRG/secom/blob/main/CONFIG.md) file to know how to configure the template in your repository.
3+
Linter to measure compliance against [SECOM](https://tqrg.github.io/secom/) convention. SECOM is a convention for making security commit messages more readable and structured. Check the [CONFIG.md](https://github.com/TQRG/secom/blob/main/CONFIG.md) file to know how to configure the template in your repository.
44

55
<p align="center">
66
<img width="600" src="assets/secomlint.svg">
@@ -13,6 +13,14 @@ pip install secomlint
1313
python -m spacy download en_core_web_lg
1414
```
1515

16+
From the source code:
17+
```
18+
git clone https://github.com/TQRG/secomlint.git
19+
cd secomlint
20+
pip install .
21+
python -m spacy download en_core_web_lg
22+
```
23+
1624
## Usage
1725

1826
```

secomlint/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SECOMlint
22

3-
Linter to measure compliance against [SECOM](https://tqrg.github.io/secom/) convention. SECOM is a convetion for making security commit messages more readable and structured. Check the [CONFIG.md](https://github.com/TQRG/secom/blob/main/CONFIG.md) file to know how to configure the template in your repository.
3+
Linter to measure compliance against [SECOM](https://tqrg.github.io/secom/) convention. SECOM is a convention for making security commit messages more readable and structured. Check the [CONFIG.md](https://github.com/TQRG/secom/blob/main/CONFIG.md) file to know how to configure the template in your repository.
44

55
<p align="center">
66
<img width="600" src="https://raw.githubusercontent.com/TQRG/secomlint/main/assets/secomlint.svg">
@@ -13,6 +13,14 @@ pip install secomlint
1313
python -m spacy download en_core_web_lg
1414
```
1515

16+
From the source code:
17+
```
18+
git clone https://github.com/TQRG/secomlint.git
19+
cd secomlint
20+
pip install .
21+
python -m spacy download en_core_web_lg
22+
```
23+
1624
## Usage
1725

1826
```

0 commit comments

Comments
 (0)