Skip to content

Commit ce0541c

Browse files
committed
chore(readme): adds instalation guide on readme
1 parent 90fa800 commit ce0541c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,24 @@ Keeping a commit policy may sound like an easy thing to do, but in reality we bo
1212

1313
Sometimes we, the devs, go _full-loco_ while programming and make mistakes when commiting. That's fine, everyone makes mistakes. But, what if those mistakes could be avoided?
1414

15+
## Instalation
16+
Just follow the commands below:
17+
18+
```bash
19+
20+
# if you don't have git, run $ sudo apt install git first
21+
22+
# clone the repo into your home
23+
$ git clone https://github.com/andre-filho/commit-helper.git ~/.commit-helper
24+
25+
# create a function in your .bashrc
26+
$ echo "commit(){ python3 ~/.commit-helper/generator.py; }" >> ~/.bashrc
27+
28+
# reload terminal
29+
$ source ~/.bashrc
30+
31+
```
32+
1533
## Project's maintainers
1634
| **Name** | **Username** |
1735
| :--------: | :-----: |

0 commit comments

Comments
 (0)