festival-gui 0.0.0

# `festival-gui`
`Festival` GUI (`egui`) client. Directly uses `festival` internals.

![Build](https://github.com/hinto-janai/festival/actions/workflows/build-gui.yml/badge.svg) ![Tests](https://github.com/hinto-janai/festival/actions/workflows/test-gui.yml/badge.svg) [![crates.io](https://img.shields.io/crates/v/festival-gui.svg)](https://crates.io/crates/festival-gui) [![docs.rs](https://docs.rs/festival-gui/badge.svg)](https://docs.rs/festival-gui)

* [Documentation](#Documentation)
* [Build](#Build)
* [License](#License)

---

## Documentation
For a broad overview of `festival-gui`'s internals, see [`src/`](https://github.com/hinto-janai/festival/festival-gui/src).

## Build
### General Info
You need [`cargo`](https://www.rust-lang.org/learn/get-started).

Building in this repo currently means building `festival-gui`. The produced binary is named `festival`.

There are `30` unit tests, you may want to run:
```
cargo test
```
before attempting a full build.

---

## Build
### General Info
You need [`cargo`](https://www.rust-lang.org/learn/get-started).

Building in this repo currently means building `festival-gui`. The produced binary is named `festival`.

There are `30` unit tests, you may want to run:
```
cargo test
```
before attempting a full build.

---

### Linux
The pre-compiled Linux binaries are built on Debian 11, you'll need these packages to build:
```
sudo apt install build-essential cmake libgtk-3-dev
```

After that, run:
```
cargo build --release
```

---

### macOS
On macOS, if you want the binary to have an icon, you must install [`cargo-bundle`](https://github.com/burtonageo/cargo-bundle).

After that, run:
```
cargo bundle --release
```
This bundles `Festival` into `Festival.app`, the way it comes in the pre-built tars for macOS.

---

### Windows
```
cargo build --release
```

There is a `build.rs` file in the repo solely for Windows-specific things:

1. It sets the icon in `File Explorer`
2. It statically links `VCRUNTIME140.dll` (the binary will not be portable without this)

---

## License
All of `Festival` is licensed under the [MIT License](https://github.com/hinto-janai/festival/LICENSE).

All of the libraries `festival-gui` (directly) uses:

| Library | Purpose | License |
|---------|---------|---------|
| [clap](https://github.com/clap-rs/clap)                            | CLI arguments            | `MIT` & `Apache-2.0`
| [crossbeam_channel](https://github.com/crossbeam-rs/crossbeam)     | Thread message passing   | `MIT` & `Apache-2.0`
| [egui](https://github.com/emilk/egui)                              | GUI                      | `MIT` & `Apache-2.0`
| [egui_extras](https://github.com/emilk/egui/crates/egui_extras)    | GUI                      | `MIT` & `Apache-2.0`
| [eframe](https://github.com/emilk/egui/crates/eframe)              | GUI                      | `MIT` & `Apache-2.0`
| [log](https://github.com/rust-lang/log)                            | Logging                  | `MIT` & `Apache-2.0`
| [image](https://github.com/image-rs/image)                         | Image processing         | `MIT`
| [serde](https://github.com/serde-rs/serde)                         | (De)serialization        | `MIT` & `Apache-2.0`
| [strum](https://github.com/Peternator7/strum)                      | Enum iteration           | `MIT`