Project Info
To the abstract and beyond
Inspiration
Scientists spend 23% of their total work time reading research papers While this is an important part of scientific training, we believe that oftentimes there is a comprehension barrier in academic research papers that are not generally written to explain something to a novice. We are a group of student researchers who understand the feeling of being unable to make it past the abstract when trying to understand a complex paper. We wanted to change that, making research more accessible and providing different avenues of understanding. This is where the idea for README.ai came from.
What it does
Watch, understand, implement - research made accessible README.ai takes in a research paper and… Create a clean tailored explainer video with a voice-over (akin to 3Blue1Brown or Khan Academy Videos) with targeted and accurate animations grounded in the research paper (minimizing video hallucinations) Create a clean tailored explainer video with a voice-over (akin to 3Blue1Brown or Khan Academy Videos) with targeted and accurate animations grounded in the research paper (minimizing video hallucinations) Highlights key concepts of the paper with text citations on a web interface Highlights key concepts of the paper with text citations on a web interface Generate a quiz for users to test their understanding of the concepts from the paper Generate a quiz for users to test their understanding of the concepts from the paper Hosts a library of your analyzed papers and educational videos to reference past materials Hosts a library of your analyzed papers and educational videos to reference past materials
How we built it
We started by testing the video with Manim and Google Veo with PDF and seeing how it makes a video using Claude API Then we built a GitHub readme extractor using the Claude and GitHub API, then integrated Claude API to make the readme easier to understand We worked on the Front end where it can take in pdf and generate the quiz to check for understanding along with returning key concepts Then we weaved in the LMNT API for voice with a script that we generated from the paper to go along with video animation We then integrated the Audio with the video and then connected the backend with the frontend, and created a folder to store the videos.
Challenges we ran into
We had to figure out how to sync the video and audio generation and linking (one or the other was working but not both) We solved this by testing out different libraries to find the most optimal pipeline configuration. Also, we ran into difficulties integrating parallel API calls, so we ended up testing out different integrations to minimize latency.
Accomplishments we're proud of
Creating a robust platform that can handle multiple research papers Designing our video generation pipeline that is tailored to scientific papers, prioritizing meaningful animations and narration to break down complex topics by prioritizing specific video creation tools (not relying solely on video creation models) Creating a fully functional web platform that is easy to use and user-centric
What we learned
How to use the Claude API to generate summaries, code, and quiz questions. How to use Claude Code for quick scaffolding and code development. How to use Veo for dynamic video generation. How to use Manim code to generate animations. How to deploy our application with Vercel.
What's next
Integrate automatically generated interactive demos within the web application to enable users to understand the paper alongside the video explanation better. Create a chatbot that the user can query during the video and at the various sections of the web application to ask clarifying questions regarding the research paper.
README.ai (read me pls)
To the abstract and beyond
Inspiration
Scientists spend 23% of their total work time reading research papers
While this is an important part of scientific training, we believe that oftentimes there is a comprehension barrier in academic research papers that are not generally written to explain something to a novice. We are a group of student researchers who understand the feeling of being unable to make it past the abstract when trying to understand a complex paper. We wanted to change that, making research more accessible and providing different avenues of understanding. This is where the idea for README.ai came from.
What it does
Watch, understand, implement - research made accessible
README.ai takes in a research paper and…
-
Create a clean tailored explainer video with a voice-over (akin to 3Blue1Brown or Khan Academy Videos) with targeted and accurate animations grounded in the research paper (minimizing video hallucinations)
-
Highlights key concepts of the paper with text citations on a web interface
-
Generate a quiz for users to test their understanding of the concepts from the paper
-
Hosts a library of your analyzed papers and educational videos to reference past materials
How we built it
- We started by testing the video with Manim and Google Veo with PDF and seeing how it makes a video using Claude API
- Then we built a GitHub readme extractor using the Claude and GitHub API, then integrated Claude API to make the readme easier to understand
- We worked on the Front end where it can take in pdf and generate the quiz to check for understanding along with returning key concepts
- Then we weaved in the LMNT API for voice with a script that we generated from the paper to go along with video animation
- We then integrated the Audio with the video and then connected the backend with the frontend, and created a folder to store the videos.
Challenges we ran into
We had to figure out how to sync the video and audio generation and linking (one or the other was working but not both) We solved this by testing out different libraries to find the most optimal pipeline configuration. Also, we ran into difficulties integrating parallel API calls, so we ended up testing out different integrations to minimize latency.
Accomplishments that we're proud of
- Creating a robust platform that can handle multiple research papers
- Designing our video generation pipeline that is tailored to scientific papers, prioritizing meaningful animations and narration to break down complex topics by prioritizing specific video creation tools (not relying solely on video creation models)
- Creating a fully functional web platform that is easy to use and user-centric
What we learned
- How to use the Claude API to generate summaries, code, and quiz questions.
- How to use Claude Code for quick scaffolding and code development.
- How to use Veo for dynamic video generation.
- How to use Manim code to generate animations.
- How to deploy our application with Vercel.
What's next for README.AI
- Integrate automatically generated interactive demos within the web application to enable users to understand the paper alongside the video explanation better.
- Create a chatbot that the user can query during the video and at the various sections of the web application to ask clarifying questions regarding the research paper.
Analysis
View
Metric
- 8
- 8
- 2
- 1
Figures cover GitHub contributors during the hackathon window. A co-authored commit counts in full for each author, so per-member totals add up to more than the whole-team figures.
Technology
- AnthropicIn code
- CSSIn code
- HTMLIn code
- Next.jsIn code
- PythonIn code
- ReactIn code
- Tailwind CSSIn code
- TypeScriptIn code
- Vercel AI SDKIn code
- Google GeminiClaimed
9 of 10 appear in the indexed code. 1 claimed on Devpost could not be matched to code, which may simply mean the tool leaves no trace in the repository.
AI coding agents
- Claude CodeConfig
Detected from committed agent config files and commit authorship. Absence of a signal is not proof an agent was unused.
Codebase size
Source size
513 KB
Source files
81
Counts recognized source files only; vendored directories, binaries and lockfiles are excluded, so this is smaller than the repository on disk.
Repository
sanjanataware/readme-ai
94 files · 2.3 MB · @ 0a4b1fb
Structure
Interface
62 files · 66%Screens, components and styles rendered to the user.
API & routing
1 file · 1%Request entry points: routes, handlers and controllers.
Application logic
15 files · 16%Domain rules, services and shared utilities.
Supporting
Layers are inferred from where files sit in the tree, not from reading the code. A project that names its directories unconventionally will read oddly here — open the file browser to check anything the diagram implies.
Languages
- TypeScript46%
- YAML32%
- Python14%
- HTML6%
- Markdown1%
- CSS1%
Share of indexed source by file size. Binary and vendored files are excluded.
Dependencies
package.json
npm · 59- @ai-sdk/anthropic
- @hookform/resolvers
- @radix-ui/react-accordion
- @radix-ui/react-alert-dialog
- @radix-ui/react-aspect-ratio
- @radix-ui/react-avatar
- @radix-ui/react-checkbox
- @radix-ui/react-collapsible
- @radix-ui/react-context-menu
- @radix-ui/react-dialog
- @radix-ui/react-dropdown-menu
- @radix-ui/react-hover-card
- @radix-ui/react-label
- @radix-ui/react-menubar
- @radix-ui/react-navigation-menu
- @radix-ui/react-popover
- @radix-ui/react-progress
- @radix-ui/react-radio-group
- +41 more
Declared in the repository’s manifests at the indexed commit. A declared package is not proof it is used, and runtime dependencies are listed first.
This project’s features have not been analysed yet.
Export this project's context (description, README, evidence, key source files) to chat with an AI agent elsewhere.