README.md includes tutorial with images on how to use templates

This commit is contained in:
Sovereignty 2024-12-04 05:26:19 +01:00
commit a426470e94
5 changed files with 30 additions and 1 deletions

7
.gitignore vendored Normal file
View file

@ -0,0 +1,7 @@
# Project place file
/*.rbxl
/sourcemap.json
# Roblox Studio lock files
/*.rbxlx.lock
/*.rbxl.lock
/.vscode

View file

@ -8,6 +8,20 @@ The default project json is a little advanced for some individuals' tastes. You
- Rojo for syncing
- Luau Language Server for syntax, intellisense, type checking, and intellisense syncing
## How To Use
Go ahead and create a new repository by selecting the plus icon on the top right of the screen.
![Select the plus icon in the top right corner of your screen](image-1.png)
A dropdown menu will open, pick the first option.
![Select New repository](image-2.png)
When creating a new repository, you will be prompted with the chance to choose the template for your new repo.
Select this repository, and then select the options shown below.
![Git content, Webhooks, Topics, Issue Labels, and Branch protection were selected underneath the chosen template repo](image.png)
## Installation
- Luau Language Server [Link](https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.luau-lsp)
@ -24,4 +38,12 @@ The default project json is a little advanced for some individuals' tastes. You
Use the init.meta.json to ignore descendant/neighbor files when syncing. This means that it will not overwrite non rojo files that may be present only in Roblox Studio.
Clone this file into whatever folder this functionality would be applicable to you.
Clone this file into whatever folder this functionality would be applicable to you.
## Branches
The repository has two protected branches.
- main
- Does not allow for code to be pushed to main, and merging a branch into main requires approval before doing so.
- testing
- Does not allow for code to be pushed to testing, however merging is permitted as this branch is intended for testing code.

BIN
image-1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 249 KiB

BIN
image-2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.8 KiB

BIN
image.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB