Skip to content
This repository has been archived by the owner on Sep 15, 2024. It is now read-only.

Commit

Permalink
Added setup message and final words.
Browse files Browse the repository at this point in the history
  • Loading branch information
ParasiteDelta authored and ParasiteDelta committed Apr 17, 2024
1 parent 4ae915c commit 89ca015
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,36 @@ Really, there was no reason why other than exploring async and websockets using
too much lately, so I figured that this would be a good starting point. Yes, it is shoddily-written and unnecessary, but why not?
And yes, this is based on the same premise as [Burgr033's work using Python, which can be found here.](https://github.com/burgr033/GlazeWM-autotiling-python)

-----
### What about-?
Yes, I know, you could use pytools to compile [the original script by Burgr033](https://github.com/burgr033/GlazeWM-autotiling-python) and run it as an executable, but I personally hate that approach and think that the packaging for Rust is superior in this regard.

Yes, I know that there's rookie mistakes and a patchy appearance, such as the unreachable code or how it looks like things were slammed together in a ghetto Large Hadron Collider, and that's because they were. I shamelessly used the general outline from [jonhoo's OBS-DO project](https://github.com/jonhoo/obs-do) to setup async, then tossed on what I could find out there which happened to be a library called [Tungstenite](https://crates.io/crates/tungstenite).

-----
### Okay, so how would I set this up?
Well, download the source code and make sure that Rust is installed on your system. Open the project folder in a terminal,
then type `cargo b -r` to build a release binary, which will be located in `glaalt\target\release\glaalt.exe`.

If all of that was too much, download the pre-made binary.

Place the
executable in a simple or memorable location, then add this rule to your `config.yaml` file for GWM:

```yaml
- command: "set minimized"
match_process_name: "/glaalt/"
```
From here, you can also add a keybind to start GlaAlt from GWM, start it from a script, or just start
it manually. It should run in the background.
-----
### Wishlist:
- Make a way to minimize this to tray or hide the window without crazy code expansion.
- Figure out why I'm so bad at programming.
- Do better.
-----
Hey, if you want to waste time improving it, go for it. Submit a PR, let's finalize this, or at least make it a bit better.
My own patchy work is GPLv3, the associated libraries are under their own licenses, assuming it even matters.

0 comments on commit 89ca015

Please sign in to comment.