Update README.md

This commit is contained in:
Damien Ostler 2024-01-14 14:54:20 -05:00 committed by GitHub
parent 5305ec8241
commit 023a4d03c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,5 +1,10 @@
# Overview
This is a repository that provides a template for you to start your Godot repositories on GitHub. This repository contains a basic project setup along with CI/CD. By default it will build for windows, linux and the web and upload their artifacts, along with deploying a build to GitHub Pages.
This is a repository that provides a template for you to start your Godot repositories on GitHub. This repository contains a basic project setup along with CI/CD. By default it will build for windows, linux and the web and upload their artifacts, along with deploying a build to GitHubDock Pages.
# Docker Image
This uses a open source docker image made for exporting from godot, it can be found here.
https://github.com/abarichello/godot-ci
# How to deploy to GitHub Pages
Go to the settings of your repository, and then on the left hand side click pages. You should then be able to click a drop down near the top of the page to deploy from a branch, deploy from the gh-pages branch once the workflow has executed.
Example Deployment https://D4M13N-D3V.github.io/godot_template/