Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
neondeex wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,11 @@

</div>

A guide for this template isn't written yet!
###Usage
1. Use git bash to clone this repository `git clone https://github.com/grilme99/roblox-project-template`
2. Install all the tools required to run the template with `aftman install`
3. Install all the packages with `wally install`
4. Open VS code and install the following extensions: Stylua, Selene, Roblox LSP
5. Build the project executing `./scripts/build.sh` in the main directory
6. Conect you project using rojo (https://www.youtube.com/watch?v=7g0ohxtKIcM) (make sure to connect the build.project.json)
Enjoy!