Skip to content

Create an Interactive Demo GIF/Video for README #1

Description

@regionalduck

📖 Problem Statement

While the repository README lists all features clearly, having an interactive visual walkthrough (GIF/video) at the top of the README.md will immediately show new users and contributors how the C++ Notebook works in real-time.

🎥 Task Goal

Create a high-quality, optimized screen recording or animated GIF showcasing the main interactive features of C++ Notebook and embed it in the README.md.

🛠️ What needs to be captured:

  1. Creating & Editing a Cell: Show CodeMirror syntax highlighting as a simple C++ hello-world program is typed.
  2. Cell Execution: Click "Run", show the compilation process, and display the final stdout output.
  3. Interactive Stdin Console: Execute a program using std::cin (e.g. asking for name/age) and type input directly into the interactive terminal cell.
  4. Customizing Standards: Toggle between C++17, C++20, and C++23 in the toolbar.
  5. Aesthetic Transitions: Smoothly drag and drop cells or toggle between Dark and Light mode.

📦 Expected Deliverables:

  • A compressed, high-frame-rate .gif (under 5MB for fast page loads) or a video link showing the application flow.
  • A Pull Request adding the media asset to the repository (e.g., in a /media or /public folder) and embedding it directly in the README.md under the repository header card.

💻 Helpful Tools for Creation:

  • Windows/Linux: ScreenToGif or OBS Studio.
  • macOS: Native screen capture (Cmd + Shift + 5) or Kap.
  • Compression: Use ezgif.com or similar tools to optimize output size.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions