[update] Readme.

main
Shinyzenith 2 years ago
parent e64e98b7cf
commit 41f16be2cd
No known key found for this signature in database
GPG Key ID: A3DFCDC66E9E2950

@ -1,34 +1,55 @@
<p align="center"><img src="https://raw.githubusercontent.com/Shinyzenith/swhkd/main/assets/swhkd.png" alt="swhkd logo"</p>
<p align=center>
<img src="./assets/swhkd.png" alt=SWHKD width=60%>
<p align=center>A next-generation hotkey daemon for Wayland/X11 written in Rust.</p>
<p align="center">
<a href="./LICENSE.md"><img src="https://img.shields.io/github/license/shinyzenith/swhkd?style=flat-square&logo=appveyor"></a>
<img src="https://img.shields.io/badge/cargo-v0.1.0-green?style=flat-square&logo=appveyor">
<img src="https://img.shields.io/github/issues/shinyzenith/swhkd?style=flat-square&logo=appveyor">
<img src="https://img.shields.io/github/forks/shinyzenith/swhkd?style=flat-square&logo=appveyor">
<img src="https://img.shields.io/github/stars/shinyzenith/swhkd?style=flat-square&logo=appveyor">
</p>
</p>
# swhkd
**S**imple **W**ayland **H**ot**K**ey **D**aemon
## SWHKD
This project is still a WIP.
swhkd is a display protocol-independent hotkey daemon made in Rust. swhkd uses an easy-to-use configuration system inspired by sxhkd so you can easily add or remove hotkeys.
It is also a drop-in replacement for sxhkd, meaning, your sxhkd config file is also compatible with swhkd.
Because swhkd can be used anywhere, the same swhkd config can be used across Xorg or Wayland desktops, and you can even use swhkd in a tty.
# Dependencies:
## Runtime:
+ Policy Kit Daemon ( polkit )
- Policy Kit Daemon ( polkit )
## Compile time:
+ `rustup`
+ `make`
- `rustup`
- `make`
# Compiling:
+ `git clone https://github.com/shinyzenith/swhkd`
+ `make setup`
+ `make clean`
+ `make` for a musl compile.
+ `make glibc` for a glibc compile.
+ `sudo make install`
- `git clone https://github.com/shinyzenith/swhkd`
- `make setup`
- `make clean`
- `make` for a musl compile.
- `make glibc` for a glibc compile.
- `sudo make install`
# Running:
`pkexec swhkd`
# Support server:
https://discord.gg/KKZRDYrRYW
# Contributors:
<img src="https://contrib.rocks/image?repo=shinyzenith/swhkd" />
<a href="https://github.com/Shinyzenith/swhkd/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Shinyzenith/swhkd" />
</a>

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 136 KiB

After

Width:  |  Height:  |  Size: 114 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 135 KiB

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 31 KiB

Loading…
Cancel
Save