updating README.txt
	
		
			
	
		
	
	
		
	
		
			All checks were successful
		
		
	
	
		
			
				
	
				Publish to docs.datacontroller.io / Deploy docs (push) Has been cancelled
				
			
		
		
	
	
				
					
				
			
		
			All checks were successful
		
		
	
	Publish to docs.datacontroller.io / Deploy docs (push) Has been cancelled
				
			This commit is contained in:
		
							
								
								
									
										15
									
								
								README.txt
									
									
									
									
									
								
							
							
						
						
									
										15
									
								
								README.txt
									
									
									
									
									
								
							@@ -1,16 +1,3 @@
 | 
			
		||||
Installation
 | 
			
		||||
 | 
			
		||||
1. brew install mkdocs
 | 
			
		||||
2. pip install mkdocs-material
 | 
			
		||||
3. pip install fontawesome_markdown
 | 
			
		||||
4. `npm install -g license-checker`
 | 
			
		||||
 | 
			
		||||
To build, navigate to the root of this repo and run:
 | 
			
		||||
    mkdocs build --clean
 | 
			
		||||
    mkdocs serve
 | 
			
		||||
 | 
			
		||||
To deploy, run the following:
 | 
			
		||||
 | 
			
		||||
`rsync -avz --exclude .git/ --del -e "ssh -p 722" ~/git/dcdocs/site/ macropeo@77.72.0.226:/home/macropeo/docs.datacontroller.io`
 | 
			
		||||
Deploy steps in build.sh
 | 
			
		||||
 | 
			
		||||
Note that the readme has been renamed to README.txt to prevent github pages from considering it to be the index by default!
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user