Documentation
README
Create Project: Scaffold a Complete Project
You are scaffolding a new project from scratch. Follow these steps to create a well-structured, immediately runnable project.
Step 1: Understand Requirements
Clarify what the user wants to build. Consider:
- What type of project? (web app, game, tool, script, API, etc.)
- What technologies? (HTML/CSS/JS, Python, Node.js, etc.)
- Any specific features or requirements mentioned?
Step 2: Plan the Structure
Before writing any code, briefly outline:
- File structure (keep it simple — avoid over-engineering)
- Core components/modules
- Key dependencies (prefer zero-dependency or minimal dependencies)
Step 3: Build It
Write all files using the Write tool. Follow these principles:
This is the opening of the README. Read the full README on GitHub.