boring_backup/README.md

34 lines
559 B
Markdown
Raw Normal View History

2022-06-30 11:35:31 +03:00
# Boring Backup
Bash powered backup tool.
# Testing
2022-05-14 00:20:02 +03:00
2022-06-30 11:35:31 +03:00
BB uses amazing test suite: https://bats-core.readthedocs.io/
2022-05-14 00:20:02 +03:00
Install Bats:
2022-05-14 00:20:02 +03:00
git clone https://github.com/bats-core/bats-core.git
bash bats-core/install.sh ~/.local
Add some Bats extensions:
2022-05-14 00:20:02 +03:00
git clone https://github.com/bats-core/bats-assert.git tests/helpers/bats-assert
git clone https://github.com/bats-core/bats-support.git tests/helpers/bats-support
Run tests:
2022-05-14 00:20:02 +03:00
make tests
2022-06-30 11:35:31 +03:00
# Linting
Run shellcheck:
make lint
# Building
2022-05-14 00:20:02 +03:00
Build docs (manpage and HTML):
2022-05-14 00:20:02 +03:00
make docs