Skip to content

Commit adcc0e2

Browse files
SnaveSutitgitbutler-client
authored andcommitted
✨ Update CONTRIBUTING.md
1 parent 912f52b commit adcc0e2

1 file changed

Lines changed: 12 additions & 15 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,18 @@ Contributions are always welcome, however, please consult @SnaveSutit before sta
1111

1212
### 🛠️ Prerequisites
1313

14-
- #### Required
14+
- #### Required
15+
- [Bun](https://bun.sh/)
16+
- [Git](https://git-scm.com/)
1517

16-
- [Node.js](https://nodejs.org/en/)
17-
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
18-
- [Git](https://git-scm.com/)
19-
20-
- #### Recommended
21-
22-
- [VSCode](https://code.visualstudio.com/)
18+
- #### Recommended
19+
- [VSCode](https://code.visualstudio.com/)
2320
> (or any other code editor, but this project has configurations for VSCode)
24-
- [Blockbench](https://www.blockbench.net/)
21+
- [Blockbench](https://www.blockbench.net/)
2522
> The repository includes [Envbench](https://github.com/SnaveSutit/envbench) to create and manage a dev instance of Blockbench, So installing Blockbench separately is not strictly required.
26-
- [SnaveSutit's Blockbench Types](https://github.com/SnaveSutit/blockbench-types)
27-
> Bleeding edge types for Blockbench plugins.<br/>Install via `yarn add -D https://github.com/SnaveSutit/blockbench-types.git`
28-
- [GitButler](https://gitbutler.com/)
23+
- [SnaveSutit's Blockbench Types](https://github.com/SnaveSutit/blockbench-types)
24+
> Bleeding edge types for Blockbench plugins.<br/>Install via `bun add -D https://github.com/SnaveSutit/blockbench-types.git`
25+
- [GitButler](https://gitbutler.com/)
2926
> A Git client for simultaneous branches on top of your existing workflow.
3027
3128
## 🖇️ Cloning the Repository
@@ -34,7 +31,7 @@ Contributions are always welcome, however, please consult @SnaveSutit before sta
3431

3532
> [How do I clone a repository?](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
3633
37-
2. Run `yarn install` to install dependencies.
34+
2. Run `bun install` to install dependencies.
3835

3936
3. Open up `src/blockbenchTypes.d.ts` and replace the first line with the following:
4037

@@ -44,9 +41,9 @@ Contributions are always welcome, however, please consult @SnaveSutit before sta
4441

4542
> By default this references my local fork of the Blockbench types to quickly add / adjust types as needed. So you need to adjust this to the official Blockbench types, or your own fork, if you're not me.
4643

47-
4. Run `yarn dev` to start the development environment, which will watch for changes and recompile the plugin.
44+
4. Run `bun run dev` to start the development environment, which will watch for changes and recompile the plugin.
4845

49-
5. Open a new terminal, or click `Split` if you're in VSCode's terminal, and run `yarn start` to start the development instance of Blockbench.
46+
5. Open a new terminal, or click `Split` if you're in VSCode's terminal, and run `bun run start` to start the development instance of Blockbench.
5047

5148
6. That's it! You're ready to start developing.
5249

0 commit comments

Comments
 (0)