← ALL PROJECTS
August 20, 2024

READMEplease.ai

A Flask app that generates Markdown docs from videos or GitHub repos.

Source →
PythonFlaskOpenAI APIweb-appdocumentationaimarkdown

READMEplease.ai is a Flask web application that generates Markdown documents by processing videos or GitHub repositories. It transcribes speech with OpenAI Whisper, captures screenshots at keyword moments, and embeds both the text and images into a single README-style document.

It is built for automated documentation workflows: point it at a repo or upload a video, then get structured Markdown back with the supporting screenshots in place.

Core capabilities:

  • Markdown generation from video or GitHub input
  • Speech transcription via OpenAI Whisper
  • Screenshot extraction and embedding
  • HTTPS support for local OAuth callbacks
  • Debug logging for troubleshooting

A demo video is available here.