mirror of
				https://github.com/yeslayla/build-godot-action.git
				synced 2025-11-04 16:23:04 +01:00 
			
		
		
		
	Add basic ReadMe.md
This commit is contained in:
		
							
								
								
									
										26
									
								
								ReadMe.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								ReadMe.md
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,26 @@
 | 
				
			|||||||
 | 
					# Build Godot
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This action builds the godot project in your `$GITHUB_WORKSPACE`, so that you can easily automate builds.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Usage
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Example:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```yaml
 | 
				
			||||||
 | 
					steps:
 | 
				
			||||||
 | 
					- uses: josephbmanley/build-godot-action@develop
 | 
				
			||||||
 | 
					  env:
 | 
				
			||||||
 | 
					    PROJECT: godot-project
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Environment Variables
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- #### PROJECT **REQUIRED**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    Name of the project files to output.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    Eg. `godot-project` will export to `godot-project.exe`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Credits
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This action uses the [godot-ci](https://github.com/aBARICHELLO/godot-ci) docker image from [BARICHELLO](https://github.com/aBARICHELLO)
 | 
				
			||||||
		Reference in New Issue
	
	Block a user