Skip to content

Commit

Permalink
added build instructions to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jbcpollak authored and av8ta committed Jun 6, 2024
1 parent f6c69d6 commit b49a389
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Leveraging truck, we wrote a small rust library called [cadmium](https://github.

The UI is built with [SvelteKit](https://kit.svelte.dev/) and [Tailwind](https://tailwindcss.com/). It is hosted with Github Pages. We use [three.js](https://threejs.org/) for rendering, which in this case uses WebGL under the hood. We use [Threlte](https://github.com/threlte/threlte) to manage the scene graph declaratively.

Native builds use [Tauri](https://tauri.app/), which is a Rust-based wrapper around OS-specific native webviews that allows us to build a native app from the same codebase.

## License

This software is offered under the [Elastic License 2.0](https://www.elastic.co/licensing/elastic-license). In summary, you can do whatever you like with this software except offer it as a service to third parties.
Expand All @@ -50,6 +52,22 @@ pnpm install
pnpm dev
```

### Native Builds

```shell
# Development
pnpm tauri dev

# Generate binaries and installers
pnpm tauri build
```

Tauri can [generate icons](https://tauri.app/v1/guides/features/icons/) for the native build with the following command:

```shell
pnpm tauri icon applications/web/public/cadmium_logo_min.svg
```

## Tooling setup

### pnpm
Expand Down

0 comments on commit b49a389

Please sign in to comment.