Yuji Ueki 2744285508 docs: create comprehensive documentation and banner
- Add comprehensive documentation suite in docs/ directory
  - ARCHITECTURE.md: System design and technical architecture
  - CONTRIBUTING.md: Development guidelines and contribution process
  - installation.md: Detailed installation instructions
  - usage.md: Command-line options and game interface guide
  - supported-languages.md: Language support status and roadmap
  - docs/images/README.md: Banner generation instructions
- Create professional banner image with GitType ASCII logo
  - Generate 1200x630px OGP-compliant PNG banner
  - Include SVG version for scalability
  - Use Ubuntu Mono font with proper spacing and readability
  - Add shell script for banner regeneration
- Update main README.md with modern design
  - Add banner image at top
  - Restructure content with better sections and emojis
  - Add catchphrase: "Show your AI who's boss: just you, your keyboard, and your coding sins"
  - Include comprehensive "Why GitType?" section with humor
  - Link to all documentation files
- Add MIT LICENSE file
- Update language support roadmap
  - Prioritize Swift, Kotlin, Ruby as high priority
  - Add more languages with realistic timelines

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-31 11:43:02 +09:00
2025-08-29 01:09:08 +09:00

GitType Banner

GitType ⌨️💻

"Show your AI who's boss: just you, your keyboard, and your coding sins"

GitType turns your own source code into typing challenges. Because why practice with boring lorem ipsum when you can type your beautiful fn main() implementations?

Features

  • 🌳 Tree-sitter powered: Extracts actual functions, not random code snippets
  • 🦀🐍 Multi-language: Rust, TypeScript, Python (more languages incoming!)
  • 📊 Git stats vibes: Track your WPM like you track your commit frequency
  • 🎯 Actually useful: Build muscle memory with real syntax patterns
  • 🔍 Smart filtering: Skip the node_modules nightmare automatically

Quick Start 🚀

# Install (yes, it's that easy)
brew install gittype

# cd into your messy codebase
cd ~/that-project-you-never-finished

# Start typing your own spaghetti code
gittype

Demo 🎮

[src/main.rs:42-58] (Rust function) 
// ^ This could be YOUR code!

fn debug_everything(life: &str) -> Result<(), PanicMode> {
    println!("It works on my machine: {}", life);
    todo!("fix this before prod")
}
> _

Type it exactly as shown. Yes, including that todo!() you left 6 months ago.

Why GitType? 🤔

  • Look busy at work → "I'm studying the codebase" (technically true!)
  • Beat the AI overlords → Type faster than ChatGPT can generate
  • Stop typing boring stuff → Your own bugs are way more interesting than lorem ipsum
  • Discover forgotten treasures → That elegant function you wrote at 3am last year
  • Procrastinate like a pro → It's code review, but gamified!
  • Embrace your legacy code → Finally face those variable names you're not proud of
  • Debug your typing skills → Because pubic static void main isn't a typo anymore
  • Therapeutic code reliving → Type through your programming journey, tears included

"Basically, you need an excuse to avoid real work, and this one's pretty good."

Documentation 📚

Perfect for when the game gets too addictive:

License 📄

MIT - Because sharing is caring (and legal requirements)


Built with ❤️ and way too much caffeine by developers who got tired of typing "hello world"

S
Description
把你的源码变成打字练习游戏的 CLI 工具。|GitHub 镜像 1.6k · 🍴 43
https://github.com/unhappychoice/gittype Readme MIT 219 MiB
Languages
Rust 99.5%
Shell 0.4%