Skip to content

Commit

Permalink
Improved release-build documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
krestenlaust authored Dec 1, 2024
1 parent 5eca21f commit 0e642f5
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,29 @@ Running the project:
```bash
npm install # Installs dependencies
npm start # Builds the project and starts a local server
```

To just build the project run `npm run build`.
```

## Build

To simply build locally, just run `npm run build`.

### Generate release
The following guide is for generating a release on Ubuntu 22.

#### Prerequisites
- Node (>= v17)
- Python (>= 3.10.x)
- An Internet connection (>= Dial-up)
- Possibly: `coreutils` for Node

#### Steps
1. `npm install`
2. `python3 util/build_songs.py`
3. `./setup build live -p release`

#### Troubleshooting
Generally, try to do things twice.

##### `Error: Unable to deserialize cloned data due to invalid or unsupported version.`

Solution: Try clear parcel cache: `rm -rf .parcel-cache/`

0 comments on commit 0e642f5

Please sign in to comment.