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