git/tustu

mirror of https://github.com/johndoe6345789/tustu.git synced 2026-04-24 13:45:00 +00:00

Files

johndoe6345789 89317fbc21 Refactor documentation and consolidate scripts

- Deleted `IMPLEMENTATION_SUMMARY.md` as its content is now integrated into other documentation.
- Added `INDEX.md` for quick navigation of the scripts folder.
- Created `MARKDOWN_STYLE.md` to establish a consistent markdown style guide for documentation.
- Updated `README.md` to reflect the new documentation structure and provide links to additional resources.
- Introduced `README_SCRIPTS.md` detailing the consolidation of scripts into `tustu_tools.py`.
- Added `REORGANIZATION_SUMMARY.md` to summarize the changes made during the scripts reorganization.
- Removed `TEST_DATA_GENERATOR_FEATURE.md` as its content is now covered in `README_SCRIPTS.md`.
- Updated `scripts/README.md` to include links to new documentation files and improve clarity.

2026-01-11 21:09:51 +00:00

1.9 KiB

Raw Blame History

Scripts Folder - Quick Index

Quick navigation guide for the scripts folder.

🎯 What You Need

I want to...	Go to...
Generate registration keys, test data, or use tools	`tustu_tools.py` - Documentation
Understand the folder organization	README_SCRIPTS.md
Access original scripts	legacy/ folder - Details
View analysis data	data/ folder - Details

📖 Documentation Files

File	Purpose
`README.md`	Quick overview and examples
`README_SCRIPTS.md`	Detailed migration guide
`TUSTU_TOOLS_README.md`	Complete tool documentation
`INDEX.md`	This file (quick navigation)

🔧 Main Tool

File: tustu_tools.py

Quick Commands:

python3 tustu_tools.py --help        # Show all commands
python3 tustu_tools.py gen-key -t    # Generate key with test data
python3 tustu_tools.py test-data -n 5  # Generate 5 test sets
python3 tustu_tools.py gui           # Launch GUI

From project root:

./tustu-tools --help
./tustu-tools gen-key --test-data

📂 Folder Contents

Main Files (scripts/)

⭐ tustu_tools.py - Unified command-line tool
📖 *.md - Documentation files

legacy/

All original individual Python scripts
Preserved for reference
See legacy/README.md

data/

JSON mapping and analysis files
Generated data files
See data/README.md

🚦 Getting Started

First time? Start with README.md
Need examples? Check TUSTU_TOOLS_README.md
Migrating code? Read README_SCRIPTS.md

1.9 KiB Raw Blame History