Skip to content

Commit

Permalink
docs: remove superfluous stuff from readme (#431)
Browse files Browse the repository at this point in the history
  • Loading branch information
xTVaser authored Jan 31, 2024
1 parent a951d70 commit 1689d29
Showing 1 changed file with 0 additions and 29 deletions.
29 changes: 0 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ The launcher uses the [Tauri](https://tauri.app/) framework, if you are interest
- [Windows](#windows)
- [Linux (Ubuntu 22.04)](#linux-ubuntu-2204)
- [Building and Running](#building-and-running)
- [Code Overview](#code-overview)
- [References](#references)
- [Why Tauri?](#why-tauri)

## Usage

Expand Down Expand Up @@ -64,29 +61,3 @@ To build and run the application locally, all you have to do is run:
yarn install
yarn tauri dev
```

### Code Overview

TODO

### References

- https://tauri.app/v1/guides/features/
- https://tauri.app/v1/api/js/
- https://svelte.dev/docs
- https://tailwindcss.com/
- https://flowbite-svelte.com/

## Why Tauri?

The gut reaction from many when looking at the launcher is _ugh, another Electron app_. This however is not the case. Tauri leverages typical HTML/CSS/JS for rendering the frontend -- but it does not do so by bundling Chromium. Instead it leverages the native WebView providers found on modern operating systems. This is also why the distribution is quite small (majority of the download size is for fonts/images/videos).

Here's a non-exhaustive list of all the benefits we get out of the box with Tauri that we'd have to build ourselves / straight-up not have available to us if we went with a non-electron GUI application framework.

- A built-in updater with private key signing
- Bundling scripts for MSI installers, AppImages, DMGs
- Essentially no differences frontend-wise across all operating systems
- No need to ship an interpreter (ie. PyQt)
- Typical web UI workflows that many people are familiar with
- The ability to painlessly write application logic in Rust
- Plethora of frontend E2E testing frameworks -- most of these are non-existant or cost money for other frameworks like Qt

0 comments on commit 1689d29

Please sign in to comment.