Skip to content

Commit

Permalink
chore: Add proper Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DashieTM committed Dec 18, 2023
1 parent bb448ea commit 3f69a18
Show file tree
Hide file tree
Showing 8 changed files with 73 additions and 2 deletions.
75 changes: 73 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,74 @@
# ReSet
# <center>ReSet</center>

A wip universal Linux settings application.
<center>

![Logo of ReSet](./assets/ReSet.png)

</center>

<center>A window manager/compositor agnostic settings application for Linux written in rust and gtk4.</center>



## Features
- Bluetooth via bluez
- Audio via PulseAudio
- Wi-Fi via NetworkManager

## Screenshots

<center>

### Audio

<img alt="Audio Screenshot of ReSet" src="./assets/reset_audio.png" width="80%">

### Wi-Fi
<img alt="Wi-Fi Screenshot of ReSet" src="./assets/reset_wifi.png" width="80%">

### Bluetooth
<img alt="Bluetooth Screenshot of ReSet" src="./assets/reset_bluetooth.png" width="80%">
</center>

## 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
<!-- AUR: -->
<!-- ```paru -S ReSet``` -->

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
Binary file added assets/ReSet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/reset_audio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/reset_audio.png~
Binary file not shown.
Binary file added assets/reset_bluetooth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/reset_bluetooth.png~
Binary file not shown.
Binary file added assets/reset_wifi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/reset_wifi.png~
Binary file not shown.

0 comments on commit 3f69a18

Please sign in to comment.