docs: add build instructions to README
This commit is contained in:
		
							parent
							
								
									adead138b0
								
							
						
					
					
						commit
						32aae34d4b
					
				
					 1 changed files with 18 additions and 0 deletions
				
			
		
							
								
								
									
										18
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,18 @@
 | 
			
		|||
# quickshell-docs
 | 
			
		||||
 | 
			
		||||
Documentation for [quickshell](https://git.outfoxxed.me/outfoxxed/quickshell).
 | 
			
		||||
 | 
			
		||||
# Building the documentation
 | 
			
		||||
 | 
			
		||||
The docs depend on:
 | 
			
		||||
- just
 | 
			
		||||
- hugo
 | 
			
		||||
- rust
 | 
			
		||||
 | 
			
		||||
To build the documentation you must be in a subdirectory of the main quickshell repo,
 | 
			
		||||
which is where the submodule clones this repo.
 | 
			
		||||
 | 
			
		||||
Run the following command to build and serve the docs locally:
 | 
			
		||||
```
 | 
			
		||||
$ just serve
 | 
			
		||||
```
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue