Update README.md
Add Contributing
This commit is contained in:
parent
de2a0436d9
commit
53cddc63c4
1 changed files with 10 additions and 4 deletions
14
README.md
14
README.md
|
|
@ -1,14 +1,20 @@
|
|||
<img src="./icon.png" width="64" height="64" /> <img src="./icon_title.png" height="64" />
|
||||
|
||||
# TurboBuilder
|
||||
Create extensions for TurboWarp using block-based coding.
|
||||
# EaglerForge Builder
|
||||
Create mods for EaglerForge using block-based coding.
|
||||
|
||||
## In development
|
||||
This project is not finished and is still being worked on. Expect bugs and problems that may prevent the site from working.
|
||||
|
||||
## Running locally
|
||||
|
||||
1. Clone the repo
|
||||
2. Run `npm i --force` in a terminal inside the folder where the repo is
|
||||
3. Run `npm run dev` in a terminal inside the folder where the repo is
|
||||
4. Visit http://localhost:5173/
|
||||
4. Visit http://localhost:5173/
|
||||
|
||||
## Contributing
|
||||
1. Fork the project
|
||||
2. Make a pull request :
|
||||
- In the `working-main` branch if the changes are ready
|
||||
- In the `working-dev` branch if they are experimental
|
||||
3. After review, we will merge or not your pull request.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue