From 0720ab6326e5d46d0f59920f30b3295ffd00b238 Mon Sep 17 00:00:00 2001 From: Lucas Oskorep Date: Mon, 2 Mar 2026 23:07:28 -0500 Subject: [PATCH] feat: initial README.md --- README.md | 31 ++++++++++++++++++++++++++++++- package.json | 2 +- 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e0ff42..e9ba9e7 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ -# Aerospike Gnome (Tiling Window Manager) \ No newline at end of file +# Aerospike Gnome (Tiling Window Manager) + +Aerospike is a simple and opinionated tiling window manager for gnome. + +This project takes inspiration from previous gnome tiling window managers such +as [forge](https://github.com/forge-ext/forge) +and [cosmic-shell](https://github.com/pop-os/gnome-shell-extension-pop-cosmic) as well as +MacOS tiling WMs, mainly [Aerospace](https://github.com/nikitabobko/AeroSpace) (not affiliated). + +## Current Features + +- Auto-tiling +- Accordion layouts with variable sizes +- Tabbed layouts +- Tree-based (albeit set depth of 2 for now) container-window paired layout similar to Aerospace +- Diagram for this is pending + +## Planned functionality + +- Full Keyboard control w/window movement +- Sub-containers (more tree layers than the 1 supported for now) +- Gap size customization + +## Not currently planned + +- Active window borders + - See my other extension for a rainbow or static border - [PrettyBorders](https://github.com//pretty-borders) +- complicated window dragging features and uis + - Aerospace supports control + drag to combine windows while moving with the mouse, and normal window dragging. + diff --git a/package.json b/package.json index 2b5deae..2c04bd6 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "url": "git+https://gitlab.com/lucasoskorep/aerospike" }, "author": "Lucas Oskorep ", - "license": "LGPL-3.0-or-later", + "license": "GPL-3.0-only", "bugs": { "url": "https://github.com/example/my-extension/issues" },