actually, nevermind; release v1.0

Author: thacuber2a03

README.md

@@ -1,2 +1,46 @@
 # rectcut.lua
-an implementation of the RectCut layouting system for Lua
+
+an implementation of the [RectCut layouting system](https://halt.software/p/rectcut-for-dead-simple-ui-layouts) for Lua.
+
+## usage
+
+clone this repository as `rectcut` wherever you want, then `require 'rectcut'`.
+this will provide you with a Rect class, which you can then instantiate by calling or by the functions `new` or `fromXYWH`.
+
+## example
+
+these examples are adapted from the article linked previously.
+
+### toolbar layout
+
+```lua
+local Rect = require 'rectcut'
+
+local layout = Rect(0, 0, 180, 16)
+
+local r1 = layout:cut_left(16)
+local r2 = layout:cut_left(16)
+local r3 = layout:cut_left(16)
+
+local r4 = layout:cut_right(16)
+local r5 = layout:cut_right(16)
+```
+
+### two-panel application
+
+```lua
+local top = layout:cut_top(16)
+	local button_close = top:cut_right(16)
+	local button_maximize = top:cut_right(16)
+	local button_minimize = top:cut_right(16)
+local title = top
+
+local bottom = layout:cut_bottom(16)
+
+local panel_left = layout:cut_left(w/2)
+local panel_right = layout
+```
+
+## license
+
+this module is free software; you can redistribute it and/or modify it under the terms of the MIT License. See [LICENSE](./LICENSE) for details.

init.lua

@@ -9,7 +9,7 @@ local min, max = math.min, math.max
 ---@field public maxY number
 ---@overload fun(minX: number, minY: number, maxX: number, maxY: number): Rect
 ---@overload fun(r: {minX: number, minY: number, maxX: number, maxY: number}): Rect
-local Rect = {}
+local Rect = { _version = "1.0" }
 Rect.__index = Rect
 
 ---Creates a new Rect. Equivalent to calling the class: `Rect(...)`.
@@ -68,6 +68,16 @@ function Rect:xywh()
         self.minY + (self.maxY - self.minY)
 end
 
+---A variant of the `get_*` methods that takes in the side to get from.
+---@param side "left"|"right"|"top"|"bottom"
+---@param a number
+---@return Rect
+function Rect:get(side, a)
+    local f = self["get_" .. side]
+    assert(f, "no such side: " .. side)
+    return f(self, a)
+end
+
 ---Same as `cut_left`, except it keeps the Rect intact.
 ---@param a number
 ---@return Rect
@@ -108,6 +118,16 @@ function Rect:get_bottom(a)
     )
 end
 
+---A variant of the `cut_*` methods that takes in the side to cut from.
+---@param side "left"|"right"|"top"|"bottom"
+---@param a number
+---@return Rect
+function Rect:cut(side, a)
+    local f = self["cut_" .. side]
+    assert(f, "no such side: " .. side)
+    return f(self, a)
+end
+
 ---Cuts `a` from the left side of the Rect, and returns the cut part.
 ---@param a number
 ---@return Rect
@@ -164,6 +184,16 @@ function Rect:add_top(a) return Rect.new(self.minX, self.minY - a, self.maxX, se
 ---@return Rect
 function Rect:add_bottom(a) return Rect.new(self.minX, self.minY, self.maxX, self.maxY + a) end
 
+---A variant of the `add_*` methods that takes in the side to add from.
+---@param side "left"|"right"|"top"|"bottom"
+---@param a number
+---@return Rect
+function Rect:add(side, a)
+    local f = self["add_" .. side]
+    assert(f, "no such side: " .. side)
+    return f(self, a)
+end
+
 ---Returns an extended version of this Rect.
 ---@param a number
 ---@return Rect