Improved README with Installation instructions
This commit is contained in:
parent
ca4f602ffe
commit
5871e71655
1 changed files with 18 additions and 2 deletions
20
README.md
20
README.md
|
@ -1,7 +1,23 @@
|
||||||
# Template Repository
|
# Template Repository
|
||||||
Meant to be used as a template when creating new repositories.
|
Meant to be used as a template when creating new repositories.
|
||||||
|
|
||||||
|
The default project json is a little advanced for some individuals' tastes. You are welcome to switch it out, or use one of the other provided project template files.
|
||||||
## Uses
|
## Uses
|
||||||
|
|
||||||
- Selene for linting
|
- Selene for linting
|
||||||
- rojo for syncing
|
- Rojo for syncing
|
||||||
- luau language server for intellisense and type checking
|
- Luau Language Server for syntax, intellisense, type checking, and intellisense syncing
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
- Luau Language Server [Click me](https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.luau-lsp)
|
||||||
|
- Has an optional Roblox Studio plugin which allows for you to have intellisense for in-studio assets like Instances.
|
||||||
|
|
||||||
|
- Rojo (One way syncing) [Click me](https://marketplace.visualstudio.com/items?itemName=evaera.vscode-rojo)
|
||||||
|
- You will need the Roblox Studio pair version of this extension.
|
||||||
|
|
||||||
|
- Selene Linting (Preferably download locally via cargo{rust}) [Click me](https://marketplace.visualstudio.com/items?itemName=Kampfkarren.selene-vscode)
|
||||||
|
|
||||||
|
- Stylua (Styling/Formatting) [Click me](https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.stylua)
|
Loading…
Reference in a new issue