doc: update README

This commit is contained in:
2026-09-09 20:35:47 +08:00
parent 30897ac79b
commit d709f1c749
+10 -10
View File
@@ -8,21 +8,21 @@
Assemblicon transforms the traditional design workflow into a **compilation-like pipeline**: Assemblicon transforms the traditional design workflow into a **compilation-like pipeline**:
- **Source Code**: Binary `jpg`, `png` image assets & Inkscape `.svg` primitives & Blender `.blend` 3D assets & etc... - **Source Code**: Binary bitmap image assets (`jpg`, `png`), scalable `.svg` primitives, Blender `.blend` 3D assets, etc.
- **Compiler Flags**: Interactive CLI parameters (color, style, variant) - **Compiler Flags**: Parameters defined by the user or passed via the CLI (color, style, variant).
- **Linker**: Python + Pillow (layering & alpha composition) - **Linker**: Python + Pillow (layering & alpha composition).
- **Binary Output**: Final `.png` / `.ico` / `.icns` icon sets - **Binary Output**: Final icon sets in FreeDesktop-compatible `.png`, Windows `.ico`, and macOS `.icns` formats.
Instead of manually tweaking 100 artboards, you define reusable components once and **compile** them on-demand with different arguments just like compiling a C program. Instead of manually tweaking 100 artboards, you define reusable components once and **compile** them on demand with different arguments, just like compiling a C program.
## Features ## Features
- **Reproducible Builds**: Every output is fully deterministic; store only the recipe, not the PNGs. - **Reproducible Builds**: Every output is fully deterministic; store only the recipe, not the PNGs.
- **Batch Assembly**: Define a recipe to generate entire icon families (light/dark, active/disabled, sizes) in one go. - **Batch Assembly**: Define a recipe to generate the entire icon set in one go.
- **Unlimited Customization**: User defined recipe is actually a Python script utilizing Assemblicon. We can achieve any forms of composition which gives our unlimited customization ability. - **Unlimited Customization**: A user-defined recipe is actually a Python script that utilizes Assemblicon. Any form of composition can be achieved, which is what gives unlimited customization ability.
- **Selective Build**: User can only compile some specific icons of the whole defined icon set. This gives the ability of checking the built icon in resource-saving way. - **Selective Build**: Only compile specific icons from the entire defined icon set. This provides a resource-saving way to check the built icons.
- **License Backtrace**: By defining the source and sink for icons, we can trace the license info (if user provide it) and produce the correct license info of final output. - **License Backtrace**: By defining the source and sink for icons, license information (if provided by the user) can be traced, and the correct license information for the final output can be produced.
## License ## License
This project is under MIT license. This project is licensed under the MIT License.