diff --git a/README.md b/README.md index 8a02150..f0577ad 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,11 @@ sohkd is a display protocol-independent hotkey daemon made in Rust (based off the original, [swhkd](https://waycrate.github.io/swhkd/)). sohkd uses an easy-to-use configuration system inspired by swhkd so you can easily add or remove hotkeys, and it integrates with the [Odilia screen reader](https://odilia.app) to provide modal access to key bindings. -Because sohkd can be used anywhere, the same sohkd config can be used across Xorg or Wayland desktops, and you can even use swhkd in a tty. +Because sohkd can be used anywhere, the same sohkd config can be used across Xorg or Wayland desktops, and you can even use sohkd in a tty. **Note: The project is a WIP.** -**BUT!! It does work right now however it's not a drop-in replacement yet. [Example config file](./docs/swhkdrc).** + +**BUT!! It does work right now [Example config file](./docs/sohkdrc).** ## Installation @@ -18,14 +19,14 @@ See [INSTALL.md](./docs/INSTALL.md) for installing sohkd. ## Running: ```bash sohks & -pkexec sohkd +sohkd ``` To refresh the config at runtime, make a script like so: ```bash #!/bin/sh -sudo killall sohkd -pkexec sohkd +killall sohkd +sohkd ``` Mark it as executable using `chmod +x `. @@ -34,12 +35,14 @@ Then call it using `setsid -f `. A better implementation using signals will be developed later. -## Support server: +## Contributors: + +Original developers: -https://discord.gg/KKZRDYrRYW +* Shinyzenith `` +* Angelo Fallaria `` +* EdenQwQ `` -## Contributors: +Adapters: - - - +* Tait Hoyem `` diff --git a/docs/sohkdrc b/docs/sohkdrc index 035d80a..84d14fa 100644 --- a/docs/sohkdrc +++ b/docs/sohkdrc @@ -1,4 +1,4 @@ -# This goes in /etc/swhkd/swhkdrc +# This goes in /etc/sohkd/sohkdrc # ! = consume key # [XYZ] = only in mode XYZ; if not mode is specified, the hotkey is *always* used diff --git a/src/config.rs b/src/config.rs index 825308d..6bab8e2 100644 --- a/src/config.rs +++ b/src/config.rs @@ -439,7 +439,7 @@ fn extract_curly_brace(line: &str) -> Vec { continue; } - // In swhkd we will parse the full range using ASCII values. + // In sohkd we will parse the full range using ASCII values. let begin_ascii_val = begin_char.parse::().unwrap() as u8; let end_ascii_val = end_char.parse::().unwrap() as u8; @@ -569,7 +569,7 @@ mod tests { #[test] fn test_existing_file() -> std::io::Result<()> { - let setup = TestPath::new("/tmp/swhkd-test-file1"); + let setup = TestPath::new("/tmp/sohkd-test-file1"); // Build a dummy file in /tmp let mut f = File::create(setup.path())?; f.write_all(