From 6a9db609382a56f89284adf15d5b35644ab3ba2c Mon Sep 17 00:00:00 2001 From: pyr0ball Date: Tue, 26 May 2026 15:22:04 -0700 Subject: [PATCH] docs: full README with badges, tool reference table, and quick start --- README.md | 102 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 65 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 10a73ec..6dbac58 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,40 @@ -# Illuscape +
-> Inkscape configured for Adobe Illustrator migrants. +# 🎨 Illuscape -Illuscape patches Inkscape's config to match Illustrator's keyboard shortcuts, -workspace layout, scroll/zoom behavior, color palettes, and document templates — -without modifying Inkscape itself. +**Inkscape that feels like Adobe Illustrator — keyboard shortcuts, scroll behavior, palettes, and templates, without touching Inkscape itself.** -## What it does +[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) +[![Inkscape](https://img.shields.io/badge/inkscape-%3E%3D1.2-orange.svg)](https://inkscape.org/) +[![Platform](https://img.shields.io/badge/platform-linux-lightgrey.svg)](#requirements) -| Feature | Detail | -|---------|--------| -| Keyboard shortcuts | Adobe Illustrator CC or CS6 presets — your choice at install | -| Scroll/zoom | Mouse wheel pans (not zooms); Ctrl+wheel zooms — matching Illustrator | -| Canvas | White background, cyan guides, rubber-band selection (touching, not enclosed) | -| Node handles | Square handles, rotation handles hidden until needed | -| Palettes | Illustrator Defaults, Grays, and Earth Tones swatches | -| Templates | Letter, A4, Web 1920x1080, Web 1280x720, Print CMYK Letter, Print CMYK A4 | -| Symbols | Common symbol library (arrows, checkmark, star, cross) | -| Recent files | 20 (matching Illustrator; Inkscape default is 4) | -| Single-window mode | On by default | +
-## Requirements +--- -- Inkscape 1.2 or later -- Python 3.8+ -- Bash 4+ +Illuscape is a config patch for Inkscape, modeled after [PhotoGIMP](https://github.com/Diolinux/PhotoGIMP). It installs replacement and overlay config files — keyboard maps, scroll/zoom prefs, palettes, templates, and a symbol library — so Inkscape behaves the way Illustrator users expect. -## Install +Nothing in Inkscape itself is modified. Uninstalling fully restores your original config. + +--- + +## What changes + +| Feature | What Illuscape sets | +|---|---| +| **Keyboard shortcuts** | Adobe Illustrator CC or CS6 presets — choose at install | +| **Scroll and zoom** | Mouse wheel pans (not zooms); Ctrl+wheel zooms | +| **Canvas** | White background, cyan guides, rubber-band selection (touching, not enclosed) | +| **Node handles** | Square handles; rotation handles hidden until needed | +| **Palettes** | Illustrator Defaults, Grays, and Earth Tones swatches | +| **Templates** | Letter, A4, Web 1920×1080, Web 1280×720, Print CMYK Letter, Print CMYK A4 | +| **Symbol library** | Arrows, checkmark, star, cross | +| **Recent files** | 20 entries (Illustrator default; Inkscape default is 4) | +| **Single-window mode** | On by default | + +--- + +## Quick start ```bash git clone https://git.opensourcesolarpunk.com/Circuit-Forge/illuscape @@ -36,32 +44,48 @@ cd illuscape Follow the prompt to choose your Illustrator era (CC or CS6), then open Inkscape. -### Non-interactive (for scripts / MenagerieOS) +--- -```bash -./install.sh --preset=cc --yes -# or -./install.sh --preset=cs6 --yes -``` +## Install + +### Requirements + +- Inkscape 1.2 or later +- Python 3.8+ +- Bash 4+ ### Supported Inkscape installs -- Native (apt, pacman, etc.) +- Native (apt, pacman, dnf, etc.) - Flatpak (`org.inkscape.Inkscape`) - Snap +### Non-interactive install (scripts / automated setup) + +```bash +# Illustrator CC shortcuts +./install.sh --preset=cc --yes + +# Illustrator CS6 shortcuts +./install.sh --preset=cs6 --yes +``` + +--- + ## Uninstall ```bash ./uninstall.sh ``` -Your original Inkscape config is restored from the backup created at install time. +Your original Inkscape config is restored from the timestamped backup created at install time. -## Tool mapping from Illustrator to Inkscape +--- + +## Tool reference — Illustrator to Inkscape | Illustrator tool | Key | Inkscape equivalent | -|-----------------|-----|---------------------| +|---|---|---| | Selection | V | Selection tool | | Direct Selection | A | Node tool | | Pen | P | Pen tool | @@ -70,9 +94,9 @@ Your original Inkscape config is restored from the backup created at install tim | Type | T | Text tool | | Rectangle | M | Rectangle tool | | Ellipse | L | Ellipse tool | -| Rotate | R | Transform > Rotate | -| Scale | S | Transform > Scale | -| Reflect | O | Transform > Flip | +| Rotate | R | Transform — Rotate | +| Scale | S | Transform — Scale | +| Reflect | O | Transform — Flip | | Gradient | G | Gradient tool | | **Mesh** | **U** | **Mesh Gradient tool (direct equivalent)** | | Eyedropper | I | Dropper tool | @@ -84,7 +108,9 @@ Your original Inkscape config is restored from the backup created at install tim | Symbol Sprayer | Shift+S | Spray tool (clone mode) | | Live Paint | K | Paint Bucket tool | -## Planned extensions (post-v1) +--- + +## Planned (post-v1) - Artboards panel - Character Styles @@ -92,9 +118,11 @@ Your original Inkscape config is restored from the backup created at install tim - Object Styles - Export for Screens (1x/2x/3x batch) +--- + ## Contributing -See [CONTRIBUTING.md](CONTRIBUTING.md). +See [CONTRIBUTING.md](CONTRIBUTING.md). Issues and PRs welcome. ## License