Collection: Github README Generators
Since Github is the defacto standard for source control, here's a new collection post to quickly create a snazzy README for your repositories
With GitHub, there are two kinds of READMEs: Profile and Repository.
Profile READMEs are available after signing up to GitHub and creating a new repository with the same name as the GitHub username. With the Profile README, it's easy to create it and make incremental changes as you go. Consider it your front door matt to welcome developers into your "code house."
The other type of README is a code repository README. These are more common when examining code projects in GitHub. When a developer creates a new code repository (which seems daily), the README is always a great way to introduce or ease a developer into how to install, use, or clone a repository whether it's a complete project, library, or demo.
However, It's always tedious to create a new code repository README every single time, but if you already have a template, it makes generating a README file extremely easy. Wouldn't it be great if we could automatically generate a template for our repository?
After looking over my collection of bookmarks, I noticed a new common theme: README generators. It's been a while since I wrote a collection post and thought this would be a great addition to the...well...collection.
Enjoy this new collection of GitHub Profile and Repository README Generators.
Profile README Generators
Created by Rahul Jain, this README generator has everything a GitHub profile could ask for in terms of what a contributor's or developer's skills include.
It has the option to include social media links, include projects you're currently working on, would like to work on, and technologies you'd like to learn, along with adding awarded and "buy me a coffee" badges to your profile.
I never thought I'd see a profile generator as a pseudo-IDE. This profile generator's by-line is "The best profile readme generator you will ever find."
There's 3 sample templates for a custom profile with the capabilities of adding text, images, stats, tech stack (skills), a profile view widget, social media widget, a GitHub snake, personal activities, and music to add your Spotify music list for coding sessions or your coding podcasts to advertise to others.
Another large and elaborate Profile generator containing GitHub badges, social media badges, activities you enjoy, tech stack images, and random dev memes (which is a nice touch).
This profile generator was created by Rishav Anand and contains a great layout for building a structured Profile README.
It's broken out into the following sections: Intro, Rapidfire (prefilled fields for quicker generation), Languages and Tools (skills), GitHub Stats, Visitor Counter, a dynamic blog post list, Spotify playlists, and Donations with support for Paypal, Buy me a Coffee, Liberapay, and Ko-fi.
One nice feature is the ability to add or remove a section with specialized fields for additional content.
Repository README Generators
Similar to the Profilinator above, the readme.so site breaks everything down into a section for a code repository README. The sections are on the left, the work area in the middle, and the preview/raw markdown on the right.
As a code repository, README generators will contain quite a bit more to explain the project and every little detail. I feel this encompasses a large number of essential, optional, and critical components to describe every aspect of the repository.
For projects, this is definitely a great README generator for a repository.
Sometimes a simple README is good enough for a simple code repository. The "Make A README" site provides a simple markdown template for creating a quick README with no bells or whistles.
As said, sometimes simple is better.
Created by Shaan Khan, this single page generator takes a unique approach to building a README through an SPA (single-page application). As you progress through the tabs and update or select specific fields on the left, the preview is generated on the right.
The generator has the following sections: Header, Badges, About this Project, Built With, Getting Started, Usage, Roadmap, Contributing, License, Authors, and Acknowledgements.
The README GEN generator uses an accordion approach for generating a README with simple edits for sections like header information, badges (through shields.io), project demo link, project screenshots, features, and installation steps.
The optional sections include Contribution Guidelines, Technologies Used, License Information, and Support Information. While building the README, the preview is on the right as you progress through the accordion.
This last site contains a Profile and Code Repository README generators. The profile generator looks extremely similar to another Profile generator on this list, but I digress.
The Profile and Repository README generators use a large number of features from all of the other generators on this list.
At the end of the process, it generates the README with tabs to Copy the Markdown, Download the Markdown, Download a Backup, or Preview the result.
- Collection: GitHub README Generators
- Collection: Build Badges
- Collection: Coronavirus (COVID-19)
- Collection: Remote Work
- Collection: Real-world Refactoring
- Collection: How to be a Great Developer
- Collection: Architect References
- Collection: Inspiration/Motivation
- Collection: Blockchain
- Collection: SQL Server Sample Databases
- Collection: Beginner Tutorials for ASP.NET MVC
- Collection: GitHub Resources for Beginners
- Collection: Cloud Design Patterns and Practices
- Collection: CSS Resources
- Collection: Docker
- Collection: Web API Best Practices