Ignore & README

This commit is contained in:
Dandaedre 2026-09-15 15:14:36 +02:00
parent 2b07888e8e
commit 84736d004e
2 changed files with 183 additions and 2 deletions

151
.gitignore vendored Normal file
View File

@ -0,0 +1,151 @@
# =============================================================================
# Win Diagnostics
# Windows diagnostic collection and analysis toolkit
# =============================================================================
# OS
.DS_Store
.AppleDouble
Thumbs.db
Thumbs.db:encryptable
ehthumbs.db
Desktop.ini
$RECYCLE.BIN/
# Editors
.idea/
.vscode/
*.swp
*.swo
*~
.#*
#*#
# Temporary files
*.tmp
*.temp
*.bak
*.old
*.orig
tmp/
temp/
.tmp/
.cache/
# Python
**pycache**/
*.py[cod]
.venv/
venv/
env/
.pytest_cache/
.mypy_cache/
.ruff_cache/
.pyright/
.coverage
.coverage.*
htmlcov/
dist/
build/
*.egg-info/
# Rust, if applicable
target/
# -----------------------------------------------------------------------------
# Local diagnostic collection
# -----------------------------------------------------------------------------
#
# Real-machine collection should go into these directories.
# They may contain private or identifying information and MUST NOT be
# committed accidentally.
#
collection/
collections/
captures/
local-data/
diagnostics-tmp/
collection-tmp/
scratch/
working/
# Crash / memory dumps
*.dmp
*.mdmp
*.hdmp
# Windows event log binaries
*.evtx
# ETW / tracing output
*.etl
# Performance traces
*.blg
# Registry exports / hives
*.reg
*.hiv
# -----------------------------------------------------------------------------
# IMPORTANT — structured diagnostic formats are NOT globally ignored
# -----------------------------------------------------------------------------
#
# Do NOT add:
#
# *.json
# *.csv
# *.xml
# *.log
# *.txt
#
# Sanitized diagnostic fixtures may intentionally use these formats.
#
# Put private/raw machine captures inside one of the ignored collection
# directories above instead.
# -----------------------------------------------------------------------------
# Generated output
output/
outputs/
out/
artifacts/
# Local configuration
.env
.env.*
!.env.example
.local/
config.local.*
*.local.yaml
*.local.yml
*.local.json
*.local.toml
# Secrets / credentials
*.secret
*.secrets
secrets/
credentials/
credentials.json
*.key
*.pem
*.p12
*.pfx
# Test output
coverage/
test-results/
junit.xml
# Runtime
*.pid
*.pid.lock
*.stackdump
core
core.*
# Archives — local diagnostic bundles should not be committed accidentally
*.zip
*.tar
*.tar.gz
*.tgz
*.7z
# -----------------------------------------------------------------------------
# Intentionally tracked
# -----------------------------------------------------------------------------
#
# schemas/
# examples/
# fixtures/
# tests/
#
# may contain JSON, XML, CSV, logs and other diagnostic representations.
#
# Fixtures MUST be sanitized before committing.
#
# uv.lock / Cargo.lock should normally be committed when applicable.
# =============================================================================

View File

@ -1,3 +1,33 @@
# win-diagnostics
# Win Diagnostics
Windows diagnostic collection and analysis toolkit producing structured, machine-readable findings from system evidence.
Win Diagnostics is a toolkit for **collecting and analysing diagnostic information from Windows systems**.
Its goal is to turn raw system evidence into structured, traceable diagnostic findings.
```text id="aj3p4b"
Windows
↓
collect
↓
analyse
↓
diagnostic.json
```
The structured diagnostic output can be inspected directly or consumed by other tools and reporting systems.
Win Diagnostics does not generate reports or PDFs; diagnostic collection and interpretation are intentionally kept independent from presentation.
## Status
🚧 **Early development / migration**
The project is being progressively rebuilt from the previous `WinDiagnostics` tooling with a cleaner separation between collection, analysis and reporting.
See `AGENT.md` for the intended architecture and development rules.
## License
Software source code is licensed under the **MIT License**.
Diagnostic data produced by the tool is not automatically covered by the software license.