Skip to content

Commit fae9b36

Browse files
docs: clean minan readme and remove stale coverage badge
1 parent 1a41d22 commit fae9b36

1 file changed

Lines changed: 17 additions & 28 deletions

File tree

README.md

Lines changed: 17 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
1-
# MinAn 1.4 CSV Quick Analysis
1+
# MinAn 1.4 - CSV Quick Analysis
22

33
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
44
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
5-
[![Tests](https://github.com/mickhornung-oss/minan-csv-analyse/actions/workflows/python-tests.yml/badge.svg)](https://github.com/mickhornung-oss/minan-csv-analyse/actions)
6-
[![codecov](https://codecov.io/gh/mickhornung-oss/minan-csv-analyse/branch/main/graph/badge.svg)](https://codecov.io/gh/mickhornung-oss/minan-csv-analyse)
5+
[![Tests](https://github.com/mickhornung-oss/minan-csv-analyse/actions/workflows/python-tests.yml/badge.svg)](https://github.com/mickhornung-oss/minan-csv-analyse/actions/workflows/python-tests.yml)
76

8-
Portable Windows desktop tool for rapid CSV analysis — load a file, get an instant structural profile, data quality report, charts, filtered views, and an HTML export. The original file is never modified.
7+
Portable Windows desktop tool for rapid CSV analysis. Load a file and get structural profiling, data quality checks, charts, filtered views, and a local HTML report export. The source CSV is not modified.
98

10-
> **Deutsch:** Portables Windows-Desktop-Tool zur schnellen CSV-Analyse mit Strukturprofil, Datenqualitaet, Diagrammen und lokalem HTML-Bericht.
9+
## Demo
1110

12-
## 📸 Demo
13-
14-
<!-- Add a screenshot here: images/minan-demo.png -->
15-
*Arbeitsansicht mit Filtern, Schnellansichten und Diagrammen.*
11+
Screenshot will be added after the next UI capture update.
1612

1713
## Features
1814

@@ -30,10 +26,7 @@ Portable Windows desktop tool for rapid CSV analysis — load a file, get an ins
3026
## Quick Start (Dev Mode)
3127

3228
```batch
33-
# 1. Install dependencies
3429
pip install -r requirements.txt
35-
36-
# 2. Run the app
3730
run_dev.bat
3831
```
3932

@@ -43,37 +36,33 @@ run_dev.bat
4336
build_release.bat
4437
```
4538

46-
Output in `dist/MinAn_1_4/MinAn.exe` portable, no Python installation needed.
39+
Output: `dist/MinAn_1_4/MinAn.exe` (portable, no Python installation needed).
4740

4841
## Tech Stack
4942

50-
- **Python** 3.10+
51-
- **PySide6** — desktop GUI
52-
- **pandas** — data processing
53-
- **matplotlib** — charts
54-
- **PyInstaller** — portable build
43+
- Python 3.10+
44+
- PySide6
45+
- pandas
46+
- matplotlib
47+
- PyInstaller
5548

5649
## Tests
5750

5851
```bash
5952
pytest tests/ -v
60-
# 155 tests passing
6153
```
6254

63-
Test coverage includes:
64-
- Service unit tests (profile, quality, chart, export, report, transform)
65-
- GUI smoke tests (offscreen, full user flow)
66-
- Stress tests for type detection consistency
55+
Current suite size: 155 tests.
6756

6857
## Project Structure
6958

70-
```
59+
```text
7160
src/minan_v1/
72-
├── domain/ # Data models and enums (dataclasses)
73-
├── services/ # Business logic — one service per concern
74-
└── ui/ # PySide6 UI components
61+
|-- domain/ # Data models and enums
62+
|-- services/ # Business logic services
63+
`-- ui/ # PySide6 UI components
7564
76-
tests/ # 17 test files, 155 tests
65+
tests/ # Test suite
7766
```
7867

7968
## Topics

0 commit comments

Comments
 (0)