docs: add project documentation files
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
38
docs/README.md
Normal file
38
docs/README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Excel & CSV Data Cleaning Mastery Bundle
|
||||
|
||||
**Ready-to-sell Python automation product.**
|
||||
9 scripts for data cleaning, deduplication, text hygiene, formatting, merging, validation, and reporting.
|
||||
|
||||
Each script ships with both a GUI (runs in your browser locally, no internet needed) and a CLI.
|
||||
|
||||
Cross-platform: Windows, macOS, Linux.
|
||||
|
||||
---
|
||||
|
||||
## Quick Start (for buyers)
|
||||
|
||||
1. Download the installer for your operating system.
|
||||
2. Run the installer. No Python knowledge required.
|
||||
3. Launch via the desktop shortcut "Launch Bundle" (or the app icon on macOS, or the AppImage on Linux).
|
||||
4. Your default browser opens to a local page where the data tool runs. Your data never leaves your computer.
|
||||
|
||||
Full instructions: see [USER-GUIDE.md](USER-GUIDE.md).
|
||||
|
||||
---
|
||||
|
||||
## Documentation Index
|
||||
|
||||
### Ships with the product (buyer-facing)
|
||||
- [USER-GUIDE.md](USER-GUIDE.md) - Installation, script reference, usage examples for both GUI and CLI.
|
||||
|
||||
### Creator-only (do not ship to buyers)
|
||||
- [BUSINESS.md](BUSINESS.md) - Business case, market analysis, pricing, marketing strategy (including the hosted browser demo as a conversion lever).
|
||||
- [TECHNICAL.md](TECHNICAL.md) - Architecture (dual CLI + Streamlit GUI), build pipeline, dev standards.
|
||||
- [DECISIONS.md](DECISIONS.md) - Locked criteria, scoring rubric, decisions log, rationale for product choices including the GUI framework decision.
|
||||
- [RECOVERY.md](RECOVERY.md) - How to rebuild the entire project from scratch if lost.
|
||||
|
||||
---
|
||||
|
||||
**Version**: 1.6
|
||||
**Last updated**: April 28, 2026
|
||||
**Owner**: Michael
|
||||
Reference in New Issue
Block a user