Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sharph committed Sep 1, 2024
1 parent 496f1eb commit ee6be9b
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/rust.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Rust
name: Build and Test

on:
push:
Expand Down
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# s-rack

[![Rust](https://img.shields.io/badge/Rust-%23000000.svg?e&logo=rust&logoColor=white)](https://www.rust-lang.org/)
[![Rust CI Status](https://github.com/sharph/s-rack/actions/workflows/rust.yml/badge.svg)](https://github.com/sharph/s-rack/actions/workflows/rust.yml)
[![Made with love at the Recurse Center](https://cloud.githubusercontent.com/assets/2883345/11325206/336ea5f4-9150-11e5-9e90-d86ad31993d8.png)](https://www.recurse.com/)

A modular softsynth

![screenshot](screenshot.png)

* [egui](https://github.com/emilk/egui) based UI
* Runs natively or [in the web browser via WASM](https://github.com/emilk/egui)

## Building and running

Like most Rust apps, s-rack uses Cargo to build:

```bash
cargo run
```

or

```bash
cargo build
```

## Developing for web

s-rack uses [Trunk](https://trunkrs.dev/) to manage building for web.

You can `trunk serve` to start a live-reloading environment or `trunk build`
to create a build in `dist/`.
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ee6be9b

Please sign in to comment.