Skip to content

Commit 0b473eb

Browse files
committed
Remove project structure section from README.md
1 parent f9ca3fc commit 0b473eb

1 file changed

Lines changed: 0 additions & 42 deletions

File tree

README.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -31,48 +31,6 @@ StepDistanceCalculator provides a high-level Python API and Command-Line Interfa
3131

3232
---
3333

34-
## Project Structure
35-
36-
```text
37-
StepDistanceCalculator/
38-
39-
├── stepdistance/ # Core package
40-
│ ├── __init__.py # Package exports & versioning
41-
│ ├── person.py # Person class (name, gender, step length, pace)
42-
│ ├── location.py # Location data class
43-
│ ├── route.py # Route and Segment classes
44-
│ ├── calculator.py # DistanceCalculator & result dataclasses
45-
│ ├── converter.py # Unit conversion module
46-
│ ├── reports.py # ReportGenerator (Text, JSON, CSV, PDF)
47-
│ ├── visualization.py # Matplotlib charts (Bar, Pie, Line)
48-
│ ├── utils.py # Validators, logging & custom exceptions
49-
│ └── cli.py # CLI & Interactive Menu Program
50-
51-
├── examples/ # Example scripts
52-
│ ├── basic_usage.py # Single distance calculation
53-
│ ├── multi_city.py # Multi-city route calculation
54-
│ └── generate_reports.py # Exporting JSON/CSV/PDF & Charts
55-
56-
├── tests/ # Pytest test suite
57-
│ ├── test_calculator.py
58-
│ ├── test_cli.py
59-
│ ├── test_converter.py
60-
│ ├── test_location.py
61-
│ ├── test_person.py
62-
│ ├── test_reports.py
63-
│ ├── test_route.py
64-
│ └── test_utils.py
65-
66-
├── docs/
67-
│ └── usage_guide.md
68-
├── pyproject.toml # Build configuration
69-
├── setup.py # Setup script
70-
├── requirements.txt # Package dependencies
71-
└── README.md
72-
```
73-
74-
---
75-
7634
## Quick Start & Installation
7735

7836
### Option 1: Install from PyPI (Recommended)

0 commit comments

Comments
 (0)