Skip to content

Commit cb2c441

Browse files
committed
docs: update project structure to match current repo layout
1 parent 3904718 commit cb2c441

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,17 +100,25 @@ pytest -q
100100
## 📦 Project Structure
101101
```bash
102102
sysinfo-cli/
103-
├── src/
103+
├── .github/ # GitHub Actions workflows (CI/CD)
104+
│ └── workflows/
105+
│ └── ci.yml
106+
├── src/ # Application source code
104107
│ └── sysinfo/
105108
│ ├── __init__.py
106109
│ └── cli.py
107-
├── tests/
110+
├── tests/ # Unit tests (pytest)
108111
│ └── test_cli.py
109-
├── pyproject.toml
110-
├── Dockerfile
111-
├── .dockerignore
112-
├── .gitignore
113-
└── README.md
112+
├── .dockerignore # Files excluded from Docker build
113+
├── .gitignore # Git ignored files
114+
├── .pre-commit-config.yaml # Pre-commit hooks (Ruff, Black, Pytest)
115+
├── Dockerfile # Docker image definition
116+
├── Makefile # Build, test, and lint automation
117+
├── pyproject.toml # Build system & dependencies
118+
├── pytest.ini # Pytest configuration
119+
├── README.md # Project documentation
120+
└── .venv/ # Local virtual environment (ignored in Git)
121+
114122
```
115123

116124
---

0 commit comments

Comments
 (0)