ge/boring_backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

feat: Replace README.rst with README.md

Browse Source
This commit is contained in:
ge
2022-06-07 21:34:35 +03:00
parent d8e7e7718a
commit eece19c9bd
2 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@@ -16,7 +16,7 @@ help:
@echo 'lint run shellcheck' @echo 'lint run shellcheck'
@echo 'docs build documentation from $(docs_dir)' @echo 'docs build documentation from $(docs_dir)'
@echo @echo
@echo See README.rst for more info. @echo See README.md for more info.
tests: tests:
# See bats(1), https://bats-core.readthedocs.io/en/latest/index.html # See bats(1), https://bats-core.readthedocs.io/en/latest/index.html

14
README.rst → README.md
View File

@@ -1,25 +1,23 @@
Testing # Testing
=======
Baf uses amazing test suite: https://bats-core.readthedocs.io/ Baf uses amazing test suite: https://bats-core.readthedocs.io/
Install Bats:: Install Bats:
git clone https://github.com/bats-core/bats-core.git git clone https://github.com/bats-core/bats-core.git
bash bats-core/install.sh ~/.local bash bats-core/install.sh ~/.local
Add some Bats extensions:: Add some Bats extensions:
git clone https://github.com/bats-core/bats-assert.git tests/helpers/bats-assert 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 git clone https://github.com/bats-core/bats-support.git tests/helpers/bats-support
Run tests:: Run tests:
make tests make tests
Building # Building
========
Build docs (manpage and HTML):: Build docs (manpage and HTML):
make docs make docs