Debian Codegraph @

texmf-dist/doc/latex/sneaker/README.md

raw
1 # sneaker — A configurable TikZ sneaker drawing
2
3 A LaTeX package that provides a highly configurable sneaker
4 illustration using TikZ. The shoe can be customised via a
5 key–value interface: colours, laces, velcro straps, eyelets,
6 decorative patterns (bolt or star), stitching, and rolling
7 wheels are all available as simple options.
8
9 ## Usage
10 ```latex
11 \usepackage{sneaker}
12
13 \begin{tikzpicture}
14 \pic{sneaker={color=red, laces=true, eyelets=true, stitching=true}};
15 \end{tikzpicture}
16 ```
17
18 ## Requirements
19
20 - LaTeX2e
21 - TikZ with library `calc`
22
23 ## ✨ Key Features
24
25 The `sneaker` package offers a wide range of customization options to create everything from a simple icon to a detailed illustration.
26
27 ### 👟 Modular Components
28 Every part of the shoe can be toggled to change the style of the sneaker:
29 * **Laces & Bow:** Detailed shoelaces (best combined with eyelets).
30 * **Velcro Straps:** Choose between a classic two-strap look or a hybrid lace-and-strap design.
31 * **Metal Eyelets:** A row of circular eyelets for the lace zone.
32 * **Detail Stitching:** Adds dashed seam lines to the upper panels and the sole for a realistic touch.
33 * **Inline Wheels:** Transform the sneaker into a roller skate with three inline wheels (`rolls`).
34
35 ### 🎨 Design & Patterns
36 Add a unique look to the side panel with built-in decorative patterns:
37 * **Bolt:** A dynamic lightning-bolt decoration.
38 * **Star:** A classic five-pointed star icon.
39 * **Custom Colors:** All patterns have their own color keys.
40
41 ### 🌈 Total Color Control
42 The package uses a "Smart Tinting" system. By default, parts like the tongue and toe cap are tinted based on your main color, but you can override every single part:
43 * `color`: The primary base color.
44 * `sole color`: Customize the rubber sole.
45 * `lace color`: Change the color of the strings and the bow.
46 * `toe cap color`: Highlight the front panel.
47 * `tongue color`: Adjust the inner shoe tongue color.
48
49 ### 📐 Technical Highlights
50 * **Isometric Perspective:** The shoe is drawn in a stylised 3D-like view.
51 * **TikZ Native:** No external images required—everything is rendered as pure vector graphics.
52 * **Scalable:** Since it's a TikZ `pic`, it can be scaled, rotated, and styled within any `tikzpicture`.
53
54 ## License
55
56 LPPL 1.3c — see `sneaker-doc.pdf` for full details.