diff --git a/README.md b/README.md index 19041fa..69e3ec1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # knoxmakers-inkscape +A bundled collection of Inkscape extensions for Knox Makers makerspace. + +## Installation + +Download the latest release zip and extract into to your Inkscape extensions directory: + +- **Linux**: `~/.config/inkscape/extensions/` +- **Linux (Flatpak)**: `~/.var/app/org.inkscape.Inkscape/config/inkscape/extensions/` +- **Linux (Snap)**: `~/snap/inkscape/current/.config/inkscape/extensions/` +- **macOS**: `~/Library/Application Support/org.inkscape.Inkscape/config/inkscape/extensions/` +- **Windows**: `%APPDATA%\inkscape\extensions\` + +## Included Extensions + +- **botbox3000** - Box generator for laser cutting +- **km-living-hinge** - Living hinge pattern generator +- **km-plot** - Detect and send designs to serial HPGL plotters/vinyl cutters +- **km-hatch** - Hatching/fill patterns +- **km-hershey** - Single Line text for plotting/engraving + +Extensions appear under **Extensions > Knox Makers** in Inkscape. + +## Releases + +Automated bundles are created daily when upstream repositories have changes.