Create a README for Your GitHub Profile

Published: 16 May 2023
on channel: Stateless Code
98
2

In one of our previous videos, we had a contribution request. The contributor, Atharva Salitri, had a profile README for his GitHub and we noted in our retrospective that it would be cool to have one for Stateless Code and my own profile.

In our last video, we set up a GitHub profile README for the Stateless Code org. It was not very straightforward or smooth experience, with a bunch of "gotchas" and mistakes along the way.

In this video, we make a GitHub README for Mike's personal profile (msducheminjr). We compose the file directly in GitHub's Markdown editor (using a draft issue for more editor tools) as needed.

You can even drag-and-drop an image into your README. Just be sure to have a line break before and after it so that it renders properly (or use HTML tags in your Markdown).

You can use your README to spice up your profile introduce yourself to the rest of GitHub.

This video covers:
00:00:00 Introduction and review of the differences between user profile README and organization profile README
00:02:44 Create the msducheminjr/msducheminjr.git repo
00:04:33 Draft the README using the GitHub markdown editor for an issue
00:05:33 Review draft of README
00:06:08 Drag and drop some images into the GitHub markdown editor
00:07:30 Add some line breaks to get pictures to render properly
00:09:42 Commit the file directly on GitHub
00:10:07 Test to see that it shows up on the profile and move the action item to Done



See other related StatelessCode videos:
- Set up a GitHub Profile README for an Organization
- Create a RubyGem 101: Retro on Version 0.5.0 and Patch Releases
- Create a RubyGem 92: Add Contributing Guidelines to the Project

See Mike's profile on GitHub:
-

Resources that we relied upon for this solution:
- Atharva Salitri's GitHub profile
- Dan Cranney ProfileMe.dev (used for social icons)

This video is CC0 - No rights reserved. (YouTube doesn't allow this option when publishing.) All code is released under the UNLICENSE. Stateless Code denies the concept of "intellectual property". Copying is not stealing.


Watch video Create a README for Your GitHub Profile online without registration, duration 11 minute 54 second in high hd quality. This video was added by user Stateless Code 16 May 2023, don't forget to share it with your friends and acquaintances, it has been viewed on our site 98 once and liked it 2 people.