Add a README.md with some basic documentation
This commit is contained in:
		
							parent
							
								
									c0541e496a
								
							
						
					
					
						commit
						5c48e7baab
					
				
					 1 changed files with 22 additions and 0 deletions
				
			
		
							
								
								
									
										22
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,22 @@
 | 
				
			||||||
 | 
					# LayerShellQt
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This component is meant for applications to be able to easily use clients based on wlr-layer-shell.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					What the protocol does is roughly explained in here: https://drewdevault.com/2018/07/29/Wayland-shells.html
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Usage
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### CMake
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					To use it from a CMake project you'll need to:
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					find_package(LayerShellQt REQUIRED)
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Then it will offer us the target `LayerShellQt::Interface` that we can link to to get access to this framework.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### C++
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can use `LayerShellQt::Shell::useLayerShell();` to enable it before any clients are created.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The class `LayerShellQt::Window` will give us access to surface-specific settings. We can get it by using `LayerShellQt::Window::get(window)` on whatever `QWindow` we need to tweak.
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue