42aae529ad7f3c9d055d946a02daf6e9b6423fd5

Message

Revise README

Diff

This diff is truncated to protect this page.

  1diff --git a/README.md b/README.md
  2index 8982679bb687561ff08eed3f185cbbe94d0440af..2191a893a2fff1e15cdb67b110b1023b6999644d 100644
  3--- a/README.md
  4+++ b/README.md
  5@@ -1,31 +1,114 @@
  6-# hy3
  7 <img align="right" style="width: 256px" src="assets/logo.svg">
  8-<a href="https://matrix.to/#/#hy3:outfoxxed.me"><img src="https://img.shields.io/badge/matrix-%23hy3:outfoxxed.me-0dbd8b?logo=matrix&style=flat-square"></a>
  9+
 10+# hy3
 11+<a href="https://matrix.to/#/#hy3:outfoxxed.me"><img src="https://img.shields.io/badge/Join%20the%20matrix%20room-%23hy3:outfoxxed.me-0dbd8b?logo=matrix&style=flat-square"></a>
 12 
 13 i3 / sway like layout for [hyprland](https://github.com/hyprwm/hyprland).
 14 
 15+[Installation](#installation), [Configuration](#configuration)
 16+
 17 ### Features
 18 - [x] i3 like tiling
 19-- [x] Window splits
 20-- [x] Window movement
 21-- [x] Window resizing
 22-- [x] Selecting a group of windows at once (and related movement)
 23-- [x] Tabbed groups
 24-- [ ] Some convenience dispatchers not found in i3 or sway
 25+- [x] Node based window manipulation (you can interact with multiple windows at once)
 26+- [x] Greatly improved tabbed node groups over base hyprland
 27+
 28+Additional features may be suggested in the repo issues or the [matrix room](https://matrix.to/#/#hy3:outfoxxed.me).
 29 
 30 ### Demo
 31 <video width="640" height="360" controls="controls" src="https://user-images.githubusercontent.com/83010835/255322916-85ae8196-8b12-4e15-b060-9872db10839f.mp4"></video>
 32 
 33 ### Stability
 34-As of now hy3 is stable enough to use normally.
 35-If you encounter any crashes or bugs please report them in the issue tracker.
 36+hy3 always tracks the latest (git) version of hyprland. It likely will not work when built against a given stable
 37+hyprland release, however it will probably work within a few commits of the latest hyprland version. Please ping
 38+`@outfoxxed:outfoxxed.me` in the [matrix room](https://matrix.to/#/#hy3-general:outfoxxed.me) or make an issue
 39+if hy3 does not build or function against the latest hyprland commit.
 40+
 41+Commits are tested for obvious crashes before pushing and usually fine, however you may occasionally find a bug.
 42+
 43+If you encounter any bugs, please report them in the issue tracker.
 44 
 45 When reporting bugs, please include:
 46 - Commit hash of the version you are running.
 47-- Steps to reproduce (if you can figure them out)
 48-- backtrace of the crash
 49+- Steps to reproduce the bug (if you can figure them out)
 50+- backtrace of the crash (if applicable)
 51+
 52+If you are too lazy to use the issue tracker, please at least ping `@outfoxxed:outfoxxed.me`
 53+in the [matrix room](https://matrix.to/#/#hy3-support:outfoxxed.me) with your bug information.
 54+
 55+## Installation
 56+### Nix
 57+#### Hyprland home manager module
 58+Assuming you use hyprland's home manager module, you can easily integrate hy3 by adding it to the plugins array.
 59+
 60+```nix
 61+# flake.nix
 62+
 63+{
 64+  inputs = {
 65+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
 66+
 67+    home-manager = {
 68+      url = "github:nix-community/home-manager";
 69+      inputs.nixpkgs.follows = "nixpkgs";
 70+    };
 71+
 72+    hyprland.url = "github:hyprwm/Hyprland";
 73+
 74+    hy3 = {
 75+      url = "github:outfoxxed/hy3";
 76+      inputs.hyprland.follows = "hyprland";
 77+    };
 78+  };
 79+
 80+  outputs = { nixpkgs, home-manager, hyprland, hy3, ... }: {
 81+    homeConfigurations."user@hostname" = home-manager.lib.homeManagerConfiguration {
 82+      pkgs = nixpkgs.legacyPackages.x86_64-linux;
 83 
 84-If you don't know how to reproduce it or can't, or you can't take a backtrace please still report the issue.
 85+      modules = [
 86+        hyprland.homeManagerModules.default
 87+
 88+        {
 89+          wayland.windowManager.hyprland = {
 90+            enable = true;
 91+            plugins = [ hy3.packages.x86_64-linux.hy3 ];
 92+          };
 93+        }
 94+      ];
 95+    };
 96+  };
 97+}
 98+```
 99+
100+#### Manual (Nix)
101+hy3's binary is availible as `${hy3.packages.<system>.hy3}/lib/libhy3.so`, so you can also
102+directly use it in your hyprland config like so:
103+
104+```nix