update

Author: programmersd21

README.md

@@ -1,22 +1,188 @@
-# EfficientManim
-
-EfficientManim is a node-based Manim editor that helps you build mathematical animations visually, preview quickly, and export clean Python code.
-
-## Highlights
-- Visual graph editor for Mobjects and Animations
-- Live preview rendering for quick iteration
-- Video render pipeline with quality presets
-- Gemini-powered helpers for code generation and voiceover
-
-## Quick Start
-1. Install dependencies:
-   ```bash
-   pip install -r requirements.txt
-   ```
-2. Run the app:
-   ```bash
-   python main.py
-   ```
-
-## Documentation
-See `docs/README.md` for architecture, workflow, and developer guidance.
+# 🌿 EfficientManim — The Ultimate Node-Based Manim IDE
+
+![Icon](icon/icon.ico)
+
+**🌈 Create mathematical animations visually with the power of Python, AI, and Production-Grade Type Safety.**
+
+---
+
+## 🚀 Key Features
+
+### 🎬 Node-Based Visual Workflow
+- **Visual Editor:** Drag-and-drop Mobjects and Animations with intuitive wiring
+- **Infinite Canvas:** Pan and zoom freely to manage large node graphs
+- **Live Preview:** Real-time static previews of individual nodes
+- **Smart Connections:** Automatic wire validation and scene synchronization
+
+### 🎯 Tooltips
+
+* Every button, panel, and action now includes a clear tooltip
+* Instantly understand what anything does without searching the documentation
+* Faster navigation, fewer mistakes, and a smoother workflow
+* The interface becomes self-explanatory, even for first-time users
+
+This makes the app easier to learn, faster to use, and far more intuitive overall.
+
+### 🎬 Multiple Scenes
+- Manage multiple scenes per project in the **Scenes** tab
+- Create, rename, delete, and switch between scenes — each with its own node graph
+- Scene state auto-saved and restored when switching
+
+### 📦 VGroup Utility
+- Select Mobject nodes → click **Create VGroup** in the **VGroups** tab
+- VGroup code automatically generated: `group_1 = VGroup(circle_1, square_1)`
+- Groups shown in expandable tree view
+
+### 🤖 Gemini AI Code Generation
+- Describe animations in plain English — AI generates Manim code
+- AI code parsed into editable nodes with correct wiring
+- Streaming responses with real-time feedback
+
+### 🎙️ AI-Powered Voiceover Studio
+- Gemini TTS Integration with multi-voice support (Zephyr, Puck, Fenrir, etc.)
+- Auto-sync animation duration to audio length
+
+### 🐙 GitHub Snippet Loader
+- Clone any GitHub repository into `~/.efficientmanim/snippets/`
+- Browse `.py` files; double-click to load into AI panel as snippet
+- All cloned repos automatically repopulated on startup
+
+### ⭐ Recents Panel
+- Top-5 most-used Mobjects + top-5 most-used Animations tracked per session
+- Persisted to `~/.efficientmanim/usage.json`
+- Double-click to instantly add to canvas
+
+### ⌨️ Editable Keybindings
+- **Help → Edit Keybindings…** opens the keybindings editor
+- Double-click any shortcut to change it
+- Duplicate detection; changes persisted to QSettings
+
+### 📁 Editable Project Name
+- Project name textbox in the top-right corner of the window
+- Rename your `.efp` file without leaving the editor
+
+### 📦 Portable Project Format (.efp)
+- Bundled images, sounds, and videos included
+- ZIP-based, cross-platform, easy to share
+
+### 🌓 Dark / Light Themes
+- Full dark mode with no white bleed-through
+- Switch via the theme button in the corner or Settings
+- QSS-based styling with ColorToken system
+
+### 🎨 Manim Class Browser
+- 60+ Manim classes in 8 categories (Geometry, Text, Graphs, 3D, Animations, etc.)
+- Search bar filters in real-time
+- Double-click or drag to add node to canvas
+
+### 🎬 Professional Video Rendering
+- Full scene export to MP4/WebM
+- Up to 4K resolution, 15–60 FPS, quality presets
+
+---
+
+## ✨ For more information
+
+See [here](docs/README.md)
+
+---
+
+## 🏠 Start
+
+Run `python main.py` to open home screen and open the editor directly.
+
+---
+
+## ⌨️ Keyboard Shortcuts
+
+| Action | Shortcut |
+|--------|----------|
+| New Project | `Ctrl+N` |
+| Open Project | `Ctrl+O` |
+| Save Project | `Ctrl+S` |
+| Save As | `Ctrl+Shift+S` |
+| Exit | `Ctrl+Q` |
+| Undo | `Ctrl+Z` |
+| Redo | `Ctrl+Y` |
+| Delete Selected | `Del` |
+| Fit View | `Ctrl+0` |
+| Auto-Layout | `Ctrl+L` |
+| Export Code | `Ctrl+E` |
+| Copy Code | `Ctrl+Shift+C` |
+| Toggle Theme | `Ctrl+T` |
+| Edit Keybindings | `Ctrl+,` |
+
+All shortcuts are editable via **Help → Edit Keybindings…**
+
+---
+
+## 🛠️ Prerequisites
+
+1. **Python 3.10+**
+2. **FFmpeg** — for video rendering (must be in PATH)
+3. **Git** — optional, for GitHub Snippet Loader
+4. **LaTeX** — optional, for local LaTeX rendering
+
+## 📦 Installation
+
+```bash
+git clone https://github.com/pro-grammer-SD/EfficientManim.git
+cd EfficientManim
+pip install -r requirements.txt
+python main.py
+```
+
+Manual install:
+```bash
+pip install manim PySide6 google-genai pydub requests numpy
+```
+
+---
+
+## 📸 Gallery
+
+### Overview & Setup
+
+![Starting up](gallery/1.png)
+Launch the application and initialize the workspace.
+
+![Blank node canvas](gallery/2.png)
+Start with a clean node canvas, ready for composition and design.
+
+![Recents Menu](gallery/3.png)
+Quickly access recently opened projects and elements from the Recents panel.
+
+---
+
+### Customization & Rendering
+
+![Tinkering with Nodes](gallery/4.png)
+Manipulate nodes interactively to refine workflows and structures.
+
+![Searching for elements](gallery/5.png)
+Use the search tool to locate elements and components efficiently.
+
+![GitHub snippets panel](gallery/6.png)
+Access GitHub snippets directly for rapid code reuse and integration.
+
+---
+
+### Features in Action
+
+![Selecting a GitHub snippet](gallery/7.png)
+Select a snippet from GitHub to integrate seamlessly into your project.
+
+![Loading the snippet](gallery/8.png)
+Load and insert external code dynamically into the workspace.
+
+![Quickly previewing with the handy Preview tab](gallery/9.png)
+Preview your work instantly for faster iteration and verification.
+
+![Rendered snippet output](gallery/10.png)
+View the resulting output, demonstrating final rendering in the node canvas.
+
+---
+
+Made with lots of ❤️💚💙 by Soumalya a.k.a. @pro-grammer-SD
+
+Discussions: https://www.reddit.com/r/manim/comments/1qck0ji/i_built_a_nodebased_manim_ide_with_ai_assistance/