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

Commit

Permalink
Corrected title, added clarity to build section.
Browse files Browse the repository at this point in the history
  • Loading branch information
ParasiteDelta authored Jul 10, 2024
1 parent a966122 commit 3287694
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GAT - GlazeWM Alternating Autotiler, written in Rust.
# GAT - GlazeWM Alternating Tiler, written in Rust.

### Why?
Really, there was no reason why other than exploring async and websockets using Rust. I haven't been messing around with programming
Expand All @@ -12,8 +12,14 @@ Yes, I know, you could use pytools to compile [the original script by Burgr033](
Yes, I know that there's rookie mistakes and a patchy appearance, such as 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,
### Okay, so how would I set this up to build from scratch?
Well, download the source code and make sure that Rust is installed on your system. I tend to use the Nightly toolchain and the GNU branch, which you can download and set as your default with the following:
```Rust
rustup install nightly-gnu
rustup default nightly-gnu
```

Open the project folder in a terminal,
then type `cargo b -r` to build a release binary, which will be located in `gat-gwm\target\release\gat-gwm.exe`.

If all of that was too much, download the pre-made binary.
Expand All @@ -27,5 +33,5 @@ From here, you can add the executable to a script, bind it to a key in GWM, or j
- [ ] 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.
Hey, you can help or contribute if you want to. Just file a PR.
My own patchy work is GPLv3, the associated libraries are under their own licenses, assuming it even matters.

0 comments on commit 3287694

Please sign in to comment.