Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# How to release

To make a release:

- [ ] Make sure you have the latest changes on `main`:

```sh
git checkout main && git pull origin main
```

- [ ] Build the artifacts with:

```sh
npm run build
```

- [ ] Package the artifacts with the readme and license:

```sh
tar -czvf gedusim.tar.gz examples/* dist/* README.md LICENSE
```

- [ ] Create a new GitHub release with the packaged artifacts.

- [ ] Add information on how to run the release:

> To serve the files locally:
>
> 1. Download the compiled artifacts (`gedusim.tar.gz`).
> 2. Extract the artifacts with `tar -xzf gedusim.tar.gz`.
> 3. Serve the files under `dist/` through a web server, (i.e. [http-server](https://www.npmjs.com/package/http-server)).
>
> You'll now be able to use the simulator locally by going to `http://localhost:8080`
50 changes: 29 additions & 21 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"test": "jest",
"start": "webpack serve --open --config webpack.dev.js",
"start-host": "webpack serve --config webpack.dev.js --host 0.0.0.0",
"build": "webpack --config webpack.prod.js",
"build": "rm -rf dist/ && webpack --config webpack.prod.js",
"format": "prettier . --write",
"lint": "prettier . --check && eslint src/"
},
Expand Down