Skip to content

Commit

Permalink
Update instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexanderson1993 committed Feb 6, 2025
1 parent b406a41 commit e8f3745
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 20 deletions.
16 changes: 7 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ by developers as they work on implementing those screens.
## Contribute Code

Thorium Nova is built using [TypeScript](http://typescriptlang.org),
[React](https://reactjs.org), [Node.js](https://nodejs.org/en/), and
[React](https://reactjs.org), [Bun](https://bun.sh), and
[git](https://guides.github.com/activities/hello-world/). Before contributing
code, make sure you are familiar with these technologies.

Expand All @@ -146,9 +146,7 @@ never used git before,

### Running Thorium Nova from Source

I recommend using [Volta](https://volta.sh) to manage your Node and NPM
versions, since it will automatically install the correct version when you work
on Thorium Nova. I also recommend using the
I recommend using the
[VS Code](https://code.visualstudio.com) editor. Thorium Nova will automatically
recommend extensions for VS Code that will help you during development.

Expand All @@ -159,12 +157,12 @@ do that by running this command after installing git:
git clone https://github.com/Thorium-Sim/thorium-nova.git
```

Once the project has been cloned, you can install dependencies using NPM and
Once the project has been cloned, you can install dependencies using Bun and
start the project.

```bash
npm install
npm run dev
bun install
bun run dev
```

This will automatically start the client and development servers and open up the
Expand Down Expand Up @@ -197,7 +195,7 @@ a new branch for your work, and installing any new dependencies.
git checkout develop
git pull
git checkout -b :your branch name:
npm install
bun install
```

From there, you can start making your changes, committing as you go and opening
Expand All @@ -210,7 +208,7 @@ are doing.
### Pull Request Review Guidelines

Before pushing your code to Github, make sure your passes our basic quality
checks by running `npm validate`. This will run automated tests, lint your code
checks by running `bun run validate`. This will run automated tests, lint your code
with Biome, run TypeScript's type checker, and format your code using Biome.

Consider creating a feature branch and opening a draft pull request before you
Expand Down
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,7 @@ Check out the [project roadmap](https://github.com/orgs/Thorium-Sim/projects/2)
for tasks that are planned, but not yet assigned to anyone. Add a comment to an
issue to ask to have that issue assigned to you.

I recommend using [Volta](https://volta.sh) to manage your Node and NPM
versions, since it will automatically install the correct version when you work
on Thorium Nova. If you're on Windows, I also recommend
[using WSL](https://docs.microsoft.com/en-us/windows/wsl/install), although
others have had success in Windows.
You'll need to install [Bun](https://bun.sh) to install dependencies and run and build Thorium Nova.

First
[install git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and
Expand All @@ -36,23 +32,23 @@ run this command to download the code:
git clone https://github.com/Thorium-Sim/thorium-nova.git
```

Once the project has been cloned, you can install dependencies using NPM. You
Once the project has been cloned, you can install dependencies using Bun. You
will also want to install the default plugin, which has the configuration and
assets for the game itself. Once you've done these two things, you can start the
project.

```bash
npm install
npm run dev
bun install
bun run dev
```

This will automatically start the client and development servers and open up the
UI in your web browser. If it doesn't automatically open, you can open it
yourself by going to http://localhost:3000.

> Note: Running `npm install` will automatically update the default plugin with
> Note: Running `bun install` will automatically update the default plugin with
> the latest assets and configuration. If you want to manually pull the latest
> default plugin from Github, you can run `npm run init:plugin`.
> default plugin from Github, you can run `bun run init:plugin`.
## Project Vision

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"format:different": "biome format .",
"semantic-release": "semantic-release",
"postinstall": "bun run init:plugin",
"validate": "concurrently --names \"lint,format,typecheck,test\" -c \"yellow.bold,magenta.bold,blue.bold,green.bold\" \"npm run lint\" \"npm run format:different\" \"npm run typecheck\" \"CI=true npm run test\"",
"validate": "concurrently --names \"lint,format,typecheck,test\" -c \"yellow.bold,magenta.bold,blue.bold,green.bold\" \"bun run lint\" \"bun run format:different\" \"bun run typecheck\" \"CI=true bun run test\"",
"init:plugin": "bun run scripts/pluginInit.ts",
"sly": "npx @sly-cli/sly"
},
Expand Down

0 comments on commit e8f3745

Please sign in to comment.