README generator for students
Generate a clean README for your student project.
MakeMyReadme turns a GitHub repository into a practical README.md for school projects, portfolio repos, bootcamp capstones, and final year projects.
Make the repo look finished
A clean README helps recruiters, teachers, mentors, and classmates understand what the project does and how to run it.
Generated from the actual code
MakeMyReadme analyzes package files, scripts, folders, and configuration hints instead of giving you a generic template.
Great for portfolio projects
Add setup, usage, project structure, screenshots notes, and deployment details so your GitHub profile feels more professional.
Review before publishing
You can review the README in the app and publish it back to GitHub through a Pull Request.
Workflow
From repository to README without guessing.
Sign in and choose the student project repository.
MakeMyReadme detects scripts, dependencies, folders, and project structure.
The app writes a README focused on setup, usage, configuration, and project context.
Review the result and create a Pull Request when you are ready.
FAQ
Can students use MakeMyReadme for school projects?
Yes. MakeMyReadme can generate README.md documentation for class assignments, portfolio repositories, bootcamp projects, and final year projects.
Does a README help a student portfolio?
Yes. A clear README makes GitHub projects easier to understand, run, and evaluate, which helps when sharing work with recruiters, teachers, or mentors.
Can it generate a README from a private student repo?
Yes. MakeMyReadme can work with repositories available to the connected GitHub account, including private repositories when access is granted.