diff --git a/README.md b/README.md index e4960e3..1aa41cb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,74 @@ -# ReSet +#
ReSet
-A wip universal Linux settings application. +
+ +![Logo of ReSet](./assets/ReSet.png) + +
+ +
A window manager/compositor agnostic settings application for Linux written in rust and gtk4.
+ + + +## Features +- Bluetooth via bluez +- Audio via PulseAudio +- Wi-Fi via NetworkManager + +## Screenshots + +
+ +### Audio + +Audio Screenshot of ReSet + +### Wi-Fi +Wi-Fi Screenshot of ReSet + +### Bluetooth +Bluetooth Screenshot of ReSet +
+ +## Packaging +ReSet is available with the following packaging solutions: + +### Flatpak +We are currently not published on flatpak due to issues with permissions. +This is being worked on... + +installation: +Download the flatpak package from the release and install with the terminal. +``` +flatpak install --user reset.flatpak +``` + +### Arch Package + + + +Manually: +Download the package from the releases tab and install it with pacman. + +```sudo pacman -U /path/to/reset``` + +### Debian Package(Ubuntu 23.04 dependencies) + +Download the package from the releases tab and install it with apt. +```sudo apt install ./path/to/reset``` +### crates +```cargo install ReSet``` +### Compiled Binary + +The compiled binary is provided in the releases. +## Roadmap + +This application was developed as a semester project for the Eastern Switzerland University of Applied Sciences. +With potential advancements as a next project, due to this, no major development will happen until February 2024. +However, there is still a roadmap for this application. + +- Plugin System +- Accessibility Features +- Better Error handling +- Customizable shortcuts +- and more diff --git a/assets/ReSet.png b/assets/ReSet.png new file mode 100644 index 0000000..956025b Binary files /dev/null and b/assets/ReSet.png differ diff --git a/assets/reset_audio.png b/assets/reset_audio.png new file mode 100644 index 0000000..41fc47c Binary files /dev/null and b/assets/reset_audio.png differ diff --git a/assets/reset_audio.png~ b/assets/reset_audio.png~ new file mode 100644 index 0000000..41fc47c Binary files /dev/null and b/assets/reset_audio.png~ differ diff --git a/assets/reset_bluetooth.png b/assets/reset_bluetooth.png new file mode 100644 index 0000000..83248fa Binary files /dev/null and b/assets/reset_bluetooth.png differ diff --git a/assets/reset_bluetooth.png~ b/assets/reset_bluetooth.png~ new file mode 100644 index 0000000..23656cb Binary files /dev/null and b/assets/reset_bluetooth.png~ differ diff --git a/assets/reset_wifi.png b/assets/reset_wifi.png new file mode 100644 index 0000000..f3baff5 Binary files /dev/null and b/assets/reset_wifi.png differ diff --git a/assets/reset_wifi.png~ b/assets/reset_wifi.png~ new file mode 100644 index 0000000..a2c1286 Binary files /dev/null and b/assets/reset_wifi.png~ differ