Skip to content

Commit 617fb83

Browse files
committed
update readme
1 parent d7705f9 commit 617fb83

File tree

1 file changed

+45
-114
lines changed

1 file changed

+45
-114
lines changed

README.md

Lines changed: 45 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
<img src="assets/ehAye.png" alt="ehAye Logo" width="300" />
66

7+
**ehAye** *(pronounced "A.I.")* — A name that nods to Canadian "eh?" and Scottish "aye" (yes)
8+
79
[![Python](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)
810
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
911
[![Linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
@@ -145,109 +147,37 @@ Your team will thank you. Your future self will thank you.
145147
<div align="center">
146148

147149
```mermaid
148-
flowchart TB
149-
subgraph YourFocus["🎯 YOUR FOCUS AREA"]
150-
direction TB
151-
A[fa:fa-brain Your Ideas]
152-
B[fa:fa-code Your Core Logic]
153-
C[fa:fa-flask Your Research]
154-
D[fa:fa-robot Your AI Models]
155-
A --> B
156-
C --> B
157-
D --> B
150+
graph LR
151+
subgraph "Your Code"
152+
Y[Write Your Logic]
158153
end
159154
160-
B ==>|Just Write Code| CLI[fa:fa-terminal ehAye™ Core CLI Framework]
161-
162-
subgraph Infrastructure["🔧 WE HANDLE ALL THIS"]
163-
direction TB
164-
165-
subgraph DevTools["🛠️ Development Tools"]
166-
DT1[fa:fa-paint-brush Black<br/>Auto-formatting]
167-
DT2[fa:fa-search Ruff<br/>Fast Linting]
168-
DT3[fa:fa-shield MyPy<br/>Type Safety]
169-
DT4[fa:fa-check-circle Pytest<br/>Testing Suite]
170-
DT5[fa:fa-code-branch Pre-commit<br/>Git Hooks]
171-
DT6[fa:fa-terminal Shell<br/>Completion]
172-
end
173-
174-
subgraph BuildSys["📦 Build System"]
175-
BS1[fa:fa-linux Linux<br/>Builds]
176-
BS2[fa:fa-apple macOS<br/>Builds]
177-
BS3[fa:fa-windows Windows<br/>Builds]
178-
BS4[fa:fa-microchip ARM64<br/>Support]
179-
BS5[fa:fa-desktop x86_64<br/>Support]
180-
BS6[fa:fa-bug Debug<br/>Builds]
181-
end
182-
183-
subgraph Package["📚 Package Management"]
184-
PK1[fa:fa-box Wheel<br/>Creation]
185-
PK2[fa:fa-upload PyPI<br/>Publishing]
186-
PK3[fa:fa-download Dependency<br/>Resolution]
187-
PK4[fa:fa-archive Source<br/>Distribution]
188-
PK5[fa:fa-certificate Package<br/>Signing]
189-
PK6[fa:fa-check Verification]
190-
end
191-
192-
subgraph Release["🚀 Release Automation"]
193-
RL1[fa:fa-tag Version<br/>Tagging]
194-
RL2[fa:fa-github GitHub<br/>Releases]
195-
RL3[fa:fa-docker Docker<br/>Images]
196-
RL4[fa:fa-file-text Changelog<br/>Generation]
197-
RL5[fa:fa-cloud CI/CD<br/>Pipeline]
198-
RL6[fa:fa-bell Notifications]
199-
end
200-
201-
subgraph Quality["✅ Quality Assurance"]
202-
QA1[fa:fa-microscope Code<br/>Coverage]
203-
QA2[fa:fa-shield-alt Security<br/>Scanning]
204-
QA3[fa:fa-chart-line Performance<br/>Metrics]
205-
QA4[fa:fa-book Documentation<br/>Check]
206-
QA5[fa:fa-sync Integration<br/>Tests]
207-
QA6[fa:fa-globe Cross-platform<br/>Tests]
208-
end
155+
subgraph "ehAye™ CLI"
156+
E[Universal Commands]
209157
end
210158
211-
CLI --> DevTools
212-
CLI --> BuildSys
213-
CLI --> Package
214-
CLI --> Release
215-
CLI --> Quality
216-
217-
subgraph Commands["💻 CLI COMMANDS"]
218-
direction LR
219-
CMD1[cli dev all]
220-
CMD2[cli build --target]
221-
CMD3[cli package dist]
222-
CMD4[cli release create]
223-
CMD5[cli proj stats]
159+
subgraph "We Handle"
160+
W1[Development Tools]
161+
W2[Build Systems]
162+
W3[Package Management]
163+
W4[Release Automation]
164+
W5[Quality Assurance]
224165
end
225166
226-
DevTools -.-> CMD1
227-
BuildSys -.-> CMD2
228-
Package -.-> CMD3
229-
Release -.-> CMD4
230-
Quality -.-> CMD5
231-
232-
style YourFocus fill:#C8E6C9,stroke:#2E7D32,stroke-width:4px,color:#000
233-
style Infrastructure fill:#FFF3E0,stroke:#F57C00,stroke-width:2px,color:#000
234-
style CLI fill:#BBDEFB,stroke:#1565C0,stroke-width:3px,color:#000
235-
style DevTools fill:#FFE0B2,stroke:#F57C00,stroke-width:2px,color:#000
236-
style BuildSys fill:#FFE0B2,stroke:#F57C00,stroke-width:2px,color:#000
237-
style Package fill:#FFE0B2,stroke:#F57C00,stroke-width:2px,color:#000
238-
style Release fill:#FFE0B2,stroke:#F57C00,stroke-width:2px,color:#000
239-
style Quality fill:#FFE0B2,stroke:#F57C00,stroke-width:2px,color:#000
240-
style Commands fill:#E8F5E9,stroke:#2E7D32,stroke-width:2px,color:#000
241-
242-
classDef focus fill:#C8E6C9,stroke:#2E7D32,stroke-width:3px,color:#000
243-
classDef framework fill:#BBDEFB,stroke:#1565C0,stroke-width:2px,color:#000
244-
classDef tool fill:#FFF3E0,stroke:#F57C00,stroke-width:1px,color:#000
245-
classDef command fill:#E8F5E9,stroke:#2E7D32,stroke-width:1px,color:#000
246-
247-
class A,B,C,D focus
248-
class CLI framework
249-
class DT1,DT2,DT3,DT4,DT5,DT6,BS1,BS2,BS3,BS4,BS5,BS6,PK1,PK2,PK3,PK4,PK5,PK6,RL1,RL2,RL3,RL4,RL5,RL6,QA1,QA2,QA3,QA4,QA5,QA6 tool
250-
class CMD1,CMD2,CMD3,CMD4,CMD5 command
167+
Y --> E
168+
E --> W1
169+
E --> W2
170+
E --> W3
171+
E --> W4
172+
E --> W5
173+
174+
style Y fill:#2e7d32,color:#fff
175+
style E fill:#1565c0,color:#fff
176+
style W1 fill:#455a64,color:#fff
177+
style W2 fill:#455a64,color:#fff
178+
style W3 fill:#455a64,color:#fff
179+
style W4 fill:#455a64,color:#fff
180+
style W5 fill:#455a64,color:#fff
251181
```
252182

253183
### 🎓 **Perfect for AI Developers & Researchers**
@@ -397,23 +327,24 @@ cli release delete 1.0.0-beta --keep-tag
397327

398328
```
399329
your-project/
400-
├── commands/ # CLI implementation
401-
│ ├── config.py # Project configuration (customize here!)
402-
│ ├── main.py # CLI entry point
403-
│ ├── subs/ # Command modules
404-
│ │ ├── build/ # Build commands
405-
│ │ ├── dev/ # Development tools
406-
│ │ ├── package/ # Package management
407-
│ │ ├── proj/ # Project utilities
408-
│ │ └── release/ # Release automation
409-
│ ├── utils/ # Shared utilities
410-
│ └── tests/ # Test suite
411-
├── tools/ # Development tools
412-
├── .pre-commit-config.yaml
413-
├── pyproject.toml # Project configuration
414-
├── setup.sh # One-command setup
415-
├── LICENSE # AGPL-3.0
416-
└── README.md # You are here!
330+
├── commands/ # CLI implementation
331+
│ ├── config.py # Project configuration (customize here!)
332+
│ ├── main.py # CLI entry point
333+
│ ├── subs/ # Command modules
334+
│ │ ├── build/ # Build commands
335+
│ │ ├── dev/ # Development tools
336+
│ │ ├── package/ # Package management
337+
│ │ ├── proj/ # Project utilities
338+
│ │ └── release/ # Release automation
339+
│ ├── utils/ # Shared utilities
340+
│ └── tests/ # Test suite
341+
├── src/ # Your core project goes here (any language)
342+
├── tools/ # Development tools
343+
├── .pre-commit-config.yaml # Precommit hook (ensures sanity)
344+
├── pyproject.toml # Project configuration
345+
├── setup.sh # One-command setup
346+
├── LICENSE # AGPL-3.0
347+
└── README.md # You are here!
417348
```
418349
419350
## 🛠️ Customization Guide

0 commit comments

Comments
 (0)