readme: add nix

This commit is contained in:
DashieTM 2024-06-06 18:52:34 +02:00
parent e839a2572f
commit 56155d29b3

View file

@ -5,11 +5,11 @@
![Logo of ReSet](./assets/ReSet.png) ![Logo of ReSet](./assets/ReSet.png)
A window manager/compositor agnostic settings application for Linux written in rust and gtk4. A window manager/compositor agnostic settings application for Linux written in rust and gtk4.
</div> </div>
## Features ## Features
- Bluetooth via bluez - Bluetooth via bluez
- Audio via PulseAudio - Audio via PulseAudio
- Wi-Fi via NetworkManager - Wi-Fi via NetworkManager
@ -23,27 +23,34 @@ A window manager/compositor agnostic settings application for Linux written in r
<img alt="Audio Screenshot of ReSet" src="./assets/reset_audio.png" width="80%"> <img alt="Audio Screenshot of ReSet" src="./assets/reset_audio.png" width="80%">
### Wi-Fi ### Wi-Fi
<img alt="Wi-Fi Screenshot of ReSet" src="./assets/reset_wifi.png" width="80%"> <img alt="Wi-Fi Screenshot of ReSet" src="./assets/reset_wifi.png" width="80%">
### Bluetooth ### Bluetooth
<img alt="Bluetooth Screenshot of ReSet" src="./assets/reset_bluetooth.png" width="80%"> <img alt="Bluetooth Screenshot of ReSet" src="./assets/reset_bluetooth.png" width="80%">
</div> </div>
## Packaging ## Packaging
ReSet is available with the following packaging solutions: ReSet is available with the following packaging solutions:
### Flatpak ### Flatpak
We are currently not published on flatpak due to issues with permissions. We are currently not published on flatpak due to issues with permissions.
This is being worked on... This is being worked on...
installation: installation:
Download the flatpak package from the release and install with the terminal. Download the flatpak package from the release and install with the terminal.
``` ```
flatpak install --user reset.flatpak flatpak install --user reset.flatpak
``` ```
### Arch Package ### Arch Package
<!-- AUR: --> <!-- AUR: -->
<!-- ```paru -S ReSet``` --> <!-- ```paru -S ReSet``` -->
Manually: Manually:
@ -56,22 +63,52 @@ sudo pacman -U /path/to/reset
### Debian Package(Ubuntu 23.04 dependencies) ### Debian Package(Ubuntu 23.04 dependencies)
Download the package from the releases tab and install it with apt. Download the package from the releases tab and install it with apt.
``` ```
sudo apt install ./path/to/reset sudo apt install ./path/to/reset
``` ```
### NixOS/Home-manager
ReSet offers a flake with a home-manager module which you can use to declaratively install ReSet and plugins.
Here is an example configuration:
```nix
#inputs
reset.url = "github:Xetibo/ReSet";
reset-plugins.url = "github:Xetibo/ReSet-Plugins";
#installation and configuration
programs.reset.enable = true;
programs.reset.config.plugins = [
inputs.reset-plugins.packages."x86_64-linux".monitor
inputs.reset-plugins.packages."x86_64-linux".keyboard
];
programs.reset.config.plugin_config = {
#custom toml config
Keyboard = {
path = "/home/user/.config/reset/keyboard.conf";
};
};
```
### crates ### crates
``` ```
cargo install reset cargo install reset
``` ```
### Compiled Binary ### Compiled Binary
The compiled binary is provided in the releases. The compiled binary is provided in the releases.
## Usage ## Usage
Besides starting the application itself, a standalone daemon version ([ReSet-Daemon](https://github.com/Xetibo/ReSet-Daemon)) also exists, which is what provides the functionality for ReSet.\ Besides starting the application itself, a standalone daemon version ([ReSet-Daemon](https://github.com/Xetibo/ReSet-Daemon)) also exists, which is what provides the functionality for ReSet.\
It is therefore possible to use a different application as well for interacting with the daemon. It is therefore possible to use a different application as well for interacting with the daemon.
By default, the daemon is integrated into ReSet and is started automatically if no other daemon is found. By default, the daemon is integrated into ReSet and is started automatically if no other daemon is found.
## Roadmap ## Roadmap
This application was developed as a semester project for the Eastern Switzerland University of Applied Sciences. This application was developed as a semester project for the Eastern Switzerland University of Applied Sciences.