Skip to content

Commit cc2106a

Browse files
committed
Update README.md
1 parent d001e3a commit cc2106a

File tree

1 file changed

+44
-51
lines changed

1 file changed

+44
-51
lines changed

README.md

Lines changed: 44 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -61,56 +61,53 @@ DisplayKit includes tool pages under `tools/` and can open them inside the app o
6161

6262
## 🚀 Features
6363

64-
### 🖥 Multi-Screen UI Builder
65-
- Create unlimited screens (Home, Settings, About…)
66-
- Auto-generates `drawScreenName()` functions
67-
- Visual screen switching system
68-
69-
### 🧱 Drag-and-Drop Elements
70-
- Rect, RoundRect, Circle
71-
- Labels, Buttons, Headers
72-
- Cards, Dividers
73-
- Progress Bars, Sliders, Toggles
74-
- Images (PNG/JPG → RGB565 or monochrome)
75-
76-
### 🖼 Image Engine
77-
- Upload PNG/JPG
78-
- Auto-converts to **RGB565** for TFT_eSPI
79-
- Auto-converts to **monochrome bitmap** for U8g2
80-
- Stores as PROGMEM arrays
81-
- Real preview inside editor
82-
83-
### 🔠 Full Font Support
64+
### 🖥 Multi-screen UI builder
65+
- Create **multiple screens** and switch between them
66+
- Auto-generates a draw function per screen (e.g. `drawHomeScreen()`)
67+
- Per-screen element lists (clear/reset a single screen without touching others)
68+
69+
### 🖥 Display driver modes
70+
- **TFT_eSPI mode**: full-color UI preview + Arduino code generation
71+
- **U8g2 OLED mode**: OLED-style preview + U8g2 code generation
72+
- Built-in display settings:
73+
- **TFT**: rotation (plus UI options for color depth / backlight / touch metadata)
74+
- **OLED**: preset constructors (I2C/SPI), rotation, contrast, flip mode, font mode, power save
75+
76+
### 🧱 Drag-and-drop elements
77+
- Shapes: Rect, RoundRect, Circle, Line, Divider
78+
- UI: Label, Button, Header, Card
79+
- Controls: Progress, Slider, Toggle
80+
- Images:
81+
- Import PNG/JPG into the canvas (stored internally as RGB565 for TFT workflows)
82+
- Preview images inside the editor
83+
84+
### 🧰 Editor workflow & productivity
85+
- Undo / Redo history
86+
- Duplicate elements
87+
- Resize handles (most elements) + drag to position
88+
- Snap-to-grid + configurable grid size
89+
- Zoom (50–200%)
90+
- Background presets + custom background color
91+
- JSON project **Export / Import**
92+
93+
### 🧩 Built-in tools (inside the app)
94+
- PixelForge (image converter) and BitCanvas Studio (animation) can open in an in-app overlay
95+
- Theme sync between DisplayKit and embedded tools (light/dark)
96+
97+
### ⚙ Code output
8498
#### TFT_eSPI
85-
- Text size control
86-
- Text color, stroke, fill
99+
- Generates: `fillRect`, `fillRoundRect` / `drawRoundRect`, `fillCircle`, `drawLine`, text primitives, etc.
100+
- Optional **TFT_eSprite** rendering (`Use sprite` toggle)
101+
- RGB565 image arrays in **PROGMEM** + `pushImage()`
87102

88103
#### U8g2
89-
- Complete font selector (hundreds of fonts)
90-
- Auto-generates correct `u8g2.setFont()` code
91-
92-
### 🧰 Editor Tools
93-
- Undo / Redo
94-
- Duplicate element
95-
- Align (Left, Right, Center, Top…)
96-
- Snap-to-grid
97-
- Zoom 50–200%
98-
- JSON project import/export
99-
100-
### ⚙ Code Output
101-
#### TFT_eSPI Mode:
102-
- `fillRect`, `drawRoundRect`, `drawString`
103-
- `pushImage()` for bitmaps
104-
- Optional **TFT_eSprite** rendering
105-
106-
#### U8g2 Mode:
107-
- `drawBox`, `drawRBox`, `drawDisc`
108-
- Monochrome bitmaps
109-
- Full font rendering
110-
111-
### 🔌 Actions & Navigation
112-
- Buttons can “Go to Screen”
113-
- Generates logic-ready comments for touch input
104+
- Generates: `drawBox`, `drawRBox` / frames, `drawDisc` / circles, `drawLine`, etc.
105+
- Font selection per text element + emits `u8g2.setFont(...)`
106+
- Note: **image elements are currently not emitted** in the U8g2 sample code output
107+
108+
### 🔌 Actions & navigation hooks
109+
- Elements can be assigned an “On click → Go to screen…” action in the editor
110+
- Code output keeps drawing code focused; touch/click wiring is left for you to implement in your input loop
114111

115112
 
116113

@@ -135,10 +132,6 @@ DisplayKit includes tool pages under `tools/` and can open them inside the app o
135132
└─ theme.css # Shared theme tokens for tool pages
136133
```
137134

138-
## License
139-
140-
See `LICENSE`.
141-
142135
 
143136

144137
## 🤝 Contribute

0 commit comments

Comments
 (0)