feat: Update README
This commit is contained in:
parent
aaa7a5c2d3
commit
8c8a6504e7
12
README.md
12
README.md
@ -1,6 +1,10 @@
|
|||||||
|
# Boring Backup
|
||||||
|
|
||||||
|
Bash powered backup tool.
|
||||||
|
|
||||||
# Testing
|
# Testing
|
||||||
|
|
||||||
Baf uses amazing test suite: https://bats-core.readthedocs.io/
|
BB uses amazing test suite: https://bats-core.readthedocs.io/
|
||||||
|
|
||||||
Install Bats:
|
Install Bats:
|
||||||
|
|
||||||
@ -16,6 +20,12 @@ Run tests:
|
|||||||
|
|
||||||
make tests
|
make tests
|
||||||
|
|
||||||
|
# Linting
|
||||||
|
|
||||||
|
Run shellcheck:
|
||||||
|
|
||||||
|
make lint
|
||||||
|
|
||||||
# Building
|
# Building
|
||||||
|
|
||||||
Build docs (manpage and HTML):
|
Build docs (manpage and HTML):
|
||||||
|
Loading…
Reference in New Issue
Block a user