Skip to content

Commit 24cc3f1

Browse files
Add branded README visuals and architecture section
1 parent 0944518 commit 24cc3f1

3 files changed

Lines changed: 132 additions & 2 deletions

File tree

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,47 @@
1+
<p align="center">
2+
<img src="./assets/banner.svg" alt="Figures Diagram banner" width="100%">
3+
</p>
4+
5+
<p align="center">
6+
<img src="https://img.shields.io/github/v/release/z595484296-dev/Figures-Diagram?display_name=tag&sort=semver" alt="Release">
7+
<img src="https://img.shields.io/github/license/z595484296-dev/Figures-Diagram" alt="License">
8+
<img src="https://img.shields.io/badge/Codex-Skill-0F766E" alt="Codex Skill">
9+
<img src="https://img.shields.io/badge/Focus-Academic%20Diagrams-2563EB" alt="Academic Diagrams">
10+
<img src="https://img.shields.io/badge/Render-OpenRouter-082F49" alt="OpenRouter">
11+
</p>
12+
113
# Figures Diagram
214

315
Codex skill for academic non-numeric diagram generation and OpenRouter-backed rendering.
416

517
This repository packages a reusable workflow for turning diagram ideas into polished English prompts for image models and, when requested, directly rendering publication-oriented draft figures.
618

7-
## Highlights
19+
## At a Glance
820

921
- Prompt engineering for flowcharts, frameworks, concept maps, taxonomies, and timelines
1022
- Academic defaults for layout, readability, color usage, and labeling
1123
- Prompt-only mode for reusable figure ideation
1224
- Production mode for direct OpenRouter image rendering
1325
- Environment-variable based credential handling instead of hardcoded secrets
1426

27+
## Preview
28+
29+
<p align="center">
30+
<img src="./assets/preview.svg" alt="Figures Diagram preview" width="100%">
31+
</p>
32+
33+
## Architecture
34+
35+
```mermaid
36+
flowchart LR
37+
A["User Diagram Request"] --> B["Figure Type Classifier"]
38+
B --> C["Input Inference and Defaults"]
39+
C --> D["Prompt Construction Engine"]
40+
D --> E["Prompt-Only Output"]
41+
D --> F["OpenRouter Production Renderer"]
42+
F --> G["Image File / Prompt File / JSON Response"]
43+
```
44+
1545
## Best Fit
1646

1747
Use this skill for:
@@ -48,6 +78,9 @@ references/
4878
style-and-tools.md
4979
scripts/
5080
render_via_openrouter.py
81+
assets/
82+
banner.svg
83+
preview.svg
5184
```
5285

5386
## Quick Start
@@ -103,7 +136,7 @@ The rendering script also supports Windows user environment variables.
103136

104137
## Companion Repository
105138

106-
- `Thesis-Pipeline` for proposal drafting, literature retrieval, and methodology planning
139+
- [`Thesis-Pipeline`](https://github.com/z595484296-dev/Thesis-Pipeline) for proposal drafting, literature retrieval, and methodology planning
107140

108141
## Design Principles
109142

assets/banner.svg

Lines changed: 43 additions & 0 deletions
Loading

assets/preview.svg

Lines changed: 54 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)