From 64fbf7effa0b1ff80b193d87e309cfa9b77a403d Mon Sep 17 00:00:00 2001 From: divyap Date: Tue, 31 Mar 2026 00:29:06 +0530 Subject: [PATCH] docs: clean up README for clarity and simplicity --- README.md | 33 ++++++++------------------------- 1 file changed, 8 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 204981e..4eaf304 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ The repository is organized by "Weeks," with each week containing multiple task --- -## 🛠️ Tech Stack +## Tech Stack * **Engine**: Three.js * **Frontend**: React (for R3F) * **Styling**: CSS Modules / Vanilla CSS @@ -53,7 +53,7 @@ The repository is organized by "Weeks," with each week containing multiple task --- -## 🏁 Week 1 Milestone Summary +## Week 1 Milestone Summary | Task | Capability | Vanilla | R3F | Thob Builder | | :--- | :--- | :--- | :--- | :--- | @@ -62,42 +62,25 @@ The repository is organized by "Weeks," with each week containing multiple task | **03** | Hover Interaction | Yes | Yes | Planned / Limited | | **04** | Click Toggle State | Yes | Yes | Unstable / Broken | -### 🔦 Key Week 1 Insights: +### Key Week 1 Insights: * **Speed Advantage**: Thob Builder is exceptionally fast for **Static Visual Configuration**. Setting up meshes and textures in the UI is roughly **3-5x faster** than writing the equivalent boilerplate in code. * **Interaction Gap**: The primary limitation currently identified is the **Interaction Engine**. Hover events and persistent state toggles (onClick) are currently unreliable or missing in the builder. --- -## 🚀 Getting Started - -### 📦 Installation +## Getting Started The project uses `yarn` for dependency management. ```bash -# Clone the repository -git clone [repo-url] - -# Install all dependencies (Monorepo root) yarn install ``` -### 💻 Development Servers -To run any specific task implementation: +### Dev Servers +To run any implementation: ```bash -# Example: Running Task 4 (R3F) -cd Week-1/Task-4/r3f +cd Week-1/Task-[N]/[vanilla|r3f] yarn dev ``` --- -## Contribution & Reporting -Each task includes a **`report.md`** file. These reports follow a standardized format to capture: -* **Complexity**: How many lines of code vs. clicks? -* **Limitation Type**: Is it a runtime, editor, or UX issue? -* **Workarounds**: How did we solve the gap? -* **Business Value**: Why does this feature matter to our users? - ---- - -**Sprint Lead**: Divya Pahuja -**Goal**: Identify the "Interactivity Threshold" where code becomes more efficient than the builder UI. +**Sprint Lead**: Divya Pahuja | **Goal**: Identify the Interaction Threshold for Thob Builder.