feat: Replace README.rst with README.md
This commit is contained in:
		
							
								
								
									
										2
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								Makefile
									
									
									
									
									
								
							@@ -16,7 +16,7 @@ help:
 | 
			
		||||
	@echo 'lint	run shellcheck'
 | 
			
		||||
	@echo 'docs	build documentation from $(docs_dir)'
 | 
			
		||||
	@echo
 | 
			
		||||
	@echo See README.rst for more info.
 | 
			
		||||
	@echo See README.md for more info.
 | 
			
		||||
 | 
			
		||||
tests:
 | 
			
		||||
	# See bats(1), https://bats-core.readthedocs.io/en/latest/index.html
 | 
			
		||||
 
 | 
			
		||||
@@ -1,25 +1,23 @@
 | 
			
		||||
Testing
 | 
			
		||||
=======
 | 
			
		||||
# Testing
 | 
			
		||||
 | 
			
		||||
Baf uses amazing test suite: https://bats-core.readthedocs.io/
 | 
			
		||||
 | 
			
		||||
Install Bats::
 | 
			
		||||
Install Bats:
 | 
			
		||||
 | 
			
		||||
    git clone https://github.com/bats-core/bats-core.git
 | 
			
		||||
    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-support.git tests/helpers/bats-support
 | 
			
		||||
 | 
			
		||||
Run tests::
 | 
			
		||||
Run tests:
 | 
			
		||||
 | 
			
		||||
    make tests
 | 
			
		||||
 | 
			
		||||
Building
 | 
			
		||||
========
 | 
			
		||||
# Building
 | 
			
		||||
 | 
			
		||||
Build docs (manpage and HTML)::
 | 
			
		||||
Build docs (manpage and HTML):
 | 
			
		||||
 | 
			
		||||
    make docs
 | 
			
		||||
		Reference in New Issue
	
	Block a user