Skip to content

Commit

Permalink
add "Building/running" section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
telamonian committed Aug 30, 2024
1 parent 0cc0ec9 commit 8542e10
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,33 @@ This will install a usable `yarn` binary. Then, in the root directory of this re
yarn install
```

## Building/running

First, initialize the application resources by running `make:assets:<gpu>`, for example:

```bash
# populate the assets/ dir
yarn make:assets:amd
```

You can then run `start` to build/launch the code and a live buildserver that will automatically rebuild the code on any changes:

```bash
yarn start
```

You can also build the package and/or distributables using the `package` and `make` commands:

```bash
# build the platform-dependent package
yarn package
```

```bash
# build the platform-dependent package and any distributables
yarn make
```

## Utility scripts

A number of utility scripts are defined under the "scripts" field of package.json. For example, to build the project, run:
Expand Down

0 comments on commit 8542e10

Please sign in to comment.