Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section about profile README #215

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ A collection of cool hidden and not so hidden features of Git and GitHub. This c
- [GitHub Talks](#github-talks)
- [SSH keys](#ssh-keys)
- [Profile Image](#profile-image)
- [Profile README](#profile-readme)
- [Repository Templates](#repository-templates)
- [Git](#git)
- [Remove All Deleted Files from the Working Tree](#remove-all-deleted-files-from-the-working-tree)
Expand Down Expand Up @@ -682,6 +683,14 @@ https://github.com/{user}.png

e.g. [https://github.com/tiimgreen.png](https://github.com/tiimgreen.png)

### Profile README

You can create a own profile README by create file `README.md` in a public repository with a name that matches your GitHub username. GitHub shows your profile README at the top of your profile page.

For example see [abhisheknaiidu/awesome-github-profile-readme](https://github.com/abhisheknaiidu/awesome-github-profile-readme).

[*Read more about Profile README*](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme)

### Repository Templates

You can enable templating on your repository which allows anyone to copy the directory structure and files, allowing them to instantly use the files (e.g. for a tutorial or if writing boilerplate code). This can be enabled in the settings of your repository.
Expand Down