Skip to content

munirrudy-sg/Boring-Slide-Eradicator-inator

Repository files navigation

Boring-Slide-Eradicator-inator

A Gemini-powered tool that transforms confusing lecture slides into clear and engaging material, making learning easier for students.

Proudly created for the Google AI Hackathon 2024.

InstallationHow To UseHow It WorksDemoAbout Us

Before and After Slides

Installation

To get the Boring-Slide-Eradicator-inator up and running on your machine, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/munirrudy-sg/Boring-Slide-Eradicator-inator.git
    cd Boring-Slide-Eradicator-inator
  2. Install Dependencies:

    pip install -r requirements.txt
  3. Run the Application:

    streamlit run main.py
  4. Verification of Installation:

    • Navigate to http://localhost:8501 in your web browser to view the app. If everything is set up correctly, you should see the Boring-Slide-Eradicator-inator interface.

How To Use

To effectively utilise the Boring-Slide-Eradicator-inator, follow these straightforward steps after installation:

  1. Import Your PDF Files:

    • Begin by importing the PDF files containing the lecture slides you wish to transform.
  2. Key In Citations (Optional):

    • If you have specific citations or sources you want referred to during the slide explanation, key them in at this stage.
  3. Exclude Unnecessary Slides (Optional):

    • Optionally, you can choose to exclude title pages, "thank you" slides, and any other slides that do not require explanation. This helps focus the transformation on content-rich slides.
  4. Choose Your Theme:

    • Select a preferred visual style or theme for the output.
  5. Process PDF:

    • Once you’ve configured the settings, click on "Process PDF" to start transforming your slides into clear and engaging material.

If you're unsure about any step, don't worry as there are detailed instructions are also provided within the app itself, guiding you through each part of the process.

How It Works

The Boring-Slide-Eradicator-inator utilises google.generativeai for processing, streamlit for user interaction and pptx-python to create slides. Here’s how the transformation process works:

Flowchart of App

Leveraging 1.5 Pro's "Output in JSON" and expanded context window, output is structured for seamless slide generation and only one prompt is needed to process the entire PDF, significantly increasing speed.

Demo

Check out the Boring-Slide-Eradicator-inator in action:

Click to watch our demo

About Us

Meet the team behind the Boring-Slide-Eradicator-inator:

We started this project to tackle a common educational challenge—poorly designed lecture slides that hinder student learning. Our tool aims to transform these slides into clear and engaging content, speeding up the understanding process for students and saving time for educators who need to optimise their presentations. By improving how educational content is presented, we hope to make learning more efficient and effective for both students and professors.

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages