Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nukeop committed Oct 10, 2022
1 parent 8c9f2b6 commit 5e3edd0
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,19 @@ Linux application launcher and multitool
## Features

- **Dmenu mode** - pipe a list of options to the launcher, when you select one it will output it to stdout. It also accepts json input.
- **App launcher** - search for applications and launch them. This works by searching for .desktop files according to freedesktop.org specifications. Currently it's slow, because it needs to search for icons in several locations. I'm planning to improve this by caching the results.
- **App launcher** - search for applications and launch them. This works by searching for .desktop files according to freedesktop.org specifications. Currently it's slow, because it needs to search for icons in several locations. I'm planning to improve this by caching the results. In the future, it will also work on Mac OS.
- **Performant** - launches in 150ms, despite being Electron. Browse and filter thousands of options without lag. Brutally mogs other JS launchers.
- Development is fast and easy thanks to Vite and Vitest. Tests run in under 1s. The program starts in dev mode with live reload in 200ms.
- **Themable** - the UI can be styled with CSS or SCSS using all their modern features. Immediate feedback due to your styles being reloaded on the fly.

## Installation

Get the latest release for your distro from the [releases page](https://github.com/nukeop/based-launcher/releases). You can also build it from source.

You will need `gtk-launch` installed on your system to launch programs.

For development, get the latest Node, NPM, and Rust.

### Building

```shell
Expand Down

0 comments on commit 5e3edd0

Please sign in to comment.