StillHammer/chineseclass
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
fc824ea243
chineseclass/tools/README.md
StillHammer 18fb87ae3f Complete Chinese learning system setup 
- Created Universal Language Learning Framework (ULLF v1.1)
- Built complete learning system for 73 chapters across 5 books
- Setup folder structure with 18 README.md files
- Created learning plans (EN + CN for Tingting)
- Defined monthly cycle, SRS system, exams, and tracking
- Setup daily logs, weekly summaries, monthly sit reps
- Ready to start learning

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-29 11:31:40 +08:00

1.4 KiB
Raw Blame History

Tools

Scripts, utilities, and automation tools for the Chinese learning system.

Purpose

This folder contains:

  • Conversion scripts (MD → JSON)
  • Game generators
  • Exam generators
  • Sit rep generators
  • Audio processors
  • Any automation tools

Planned Tools

Content Processing

  • md-to-json.js - Convert Markdown chapters to JSON format
  • generate-games.js - Auto-generate 3 games per chapter
  • validate-json.js - Check JSON structure compliance

Tracking & Reporting

  • generate-weekly-summary.js - Create weekly summaries from daily logs
  • generate-sitrep.js - Create monthly sit rep (MD + HTML)
  • calculate-metrics.js - Compute streak, consistency, velocity, etc.

Exam System

  • generate-exam.js - Create exams based on month's content
  • grade-exam.js - Helper for grading exams
  • exam-analysis.js - Analyze exam results and trends

Utilities

  • audio-organizer.js - Organize and rename audio files
  • chapter-tracker.js - Track SRS review schedule
  • backup.js - Backup tracking data

Usage

Each tool should have:

  • Clear documentation
  • Usage examples
  • Error handling
  • Command-line interface

Development

Tools can be written in:

  • JavaScript/Node.js (preferred for classGen integration)
  • Python (for data processing)
  • Bash (for simple automation)

Notes

  • Keep tools modular and focused
  • Document dependencies clearly
  • Include tests for critical tools
  • Version control tool updates