mirror of
https://github.com/johndoe6345789/tustu.git
synced 2026-04-24 13:45:00 +00:00
johndoe6345789
89317fbc21
- 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.
69 lines
1.9 KiB
Markdown
69 lines
1.9 KiB
Markdown
# 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](TUSTU_TOOLS_README.md) |
|
|
| Understand the folder organization | [README_SCRIPTS.md](README_SCRIPTS.md) |
|
|
| Access original scripts | [legacy/](legacy/) folder - [Details](legacy/README.md) |
|
|
| View analysis data | [data/](data/) folder - [Details](data/README.md) |
|
|
|
|
## 📖 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:**
|
|
```bash
|
|
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:**
|
|
```bash
|
|
./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](legacy/README.md)
|
|
|
|
### data/
|
|
- JSON mapping and analysis files
|
|
- Generated data files
|
|
- See [data/README.md](data/README.md)
|
|
|
|
## 🚦 Getting Started
|
|
|
|
1. **First time?** Start with [README.md](README.md)
|
|
2. **Need examples?** Check [TUSTU_TOOLS_README.md](TUSTU_TOOLS_README.md)
|
|
3. **Migrating code?** Read [README_SCRIPTS.md](README_SCRIPTS.md)
|
|
|
|
## 🔗 Quick Links
|
|
|
|
- [Complete Documentation](TUSTU_TOOLS_README.md)
|
|
- [Legacy Scripts Info](legacy/README.md)
|
|
- [Data Files Info](data/README.md)
|
|
- [Project Root](../)
|