Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Murturtle authored Mar 8, 2024
1 parent ad80903 commit 7147471
Showing 1 changed file with 2 additions and 25 deletions.
27 changes: 2 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,4 @@
# Example TypeScript Mod [![NodeJS with Webpack](https://github.com/eaglerforge/example-typescript-mod/actions/workflows/webpack.yml/badge.svg)](https://github.com/eaglerforge/example-typescript-mod/actions/workflows/webpack.yml) [![buildtest.exe](https://github.com/eaglerforge/example-typescript-mod/actions/workflows/Buildtest.yml/badge.svg)](https://github.com/eaglerforge/example-typescript-mod/actions/workflows/Buildtest.yml)
Example EaglerForge mod template. ( too crazy to think )
# Burmod [![NodeJS with Webpack](https://github.com/eaglerforge/example-typescript-mod/actions/workflows/webpack.yml/badge.svg)](https://github.com/eaglerforge/example-typescript-mod/actions/workflows/webpack.yml) [![buildtest.exe](https://github.com/eaglerforge/example-typescript-mod/actions/workflows/Buildtest.yml/badge.svg)](https://github.com/eaglerforge/example-typescript-mod/actions/workflows/Buildtest.yml)

## How to build?
You can use 3 build systems, bun is for linux - macos machines, esbuild/webpack is cross platform really.

# 1 - webpack

1. Run `npm i`
2. Modify your files accordingly.
2. Run `npm run build`

# 2 - Bun
WARNING : Bun is experimental on windows

1. Run `npm install -g bun`
2. Run `bun install`
3. Modify your files accordingly.
4. Run `bun run build-bun`
5. profit
# 3 - esbuild
1. Run `npm install -g esbuild`
2. Modify your files accordingly.
3. Run `npn run build-es`
4. profit ( again )
## Notes
- All build tasks will generate source maps and only the 2 and 3 build task will watch your files.
`bun run build`

0 comments on commit 7147471

Please sign in to comment.