Article version: GitHub.com
Article version: GitHub.com
You can add a README to your GitHub profile to tell other people about yourself.
In this article
About your profile README
You can share information about yourself with the community on GitHub by creating a profile README. GitHub shows your profile README at the top of your profile page.
GitHub ReadME Linus Torvalds about kernel. Patches are distributed in the traditional gzip and the newer bzip2 format. When you look at a project’s repository on GitHub, you will see a header, a list of files, and some text describing what the project is, and anything else the author wants you to know about it.
You decide what information to include in your profile README, so you have full control over how you present yourself on GitHub. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README.
- An 'About me' section that describes your work and interests
- Contributions you're proud of, and context about those contributions
- Guidance for getting help in communities where you're involved
You can format text and include emoji, images, and GIFs in your profile README by using GitHub Flavored Markdown. For more information, see 'Getting started with writing and formatting on GitHub.'
Prerequisites
GitHub will display your profile README on your profile page if all of the following are true.
- You've created a repository with a name that matches your GitHub username.
- The repository is public.
- The repository contains a file named README.md in its root.
- The README.md file contains any content.
Note: If you created a public repository with the same name as your username before July 2020, GitHub won't automatically show the repository's README on your profile. You can manually share the repository's README to your profile by going to the repository on GitHub.com and clicking Share to profile.
Adding a profile README
In the upper-right corner of any page, use the drop-down menu, and select New repository.
Under 'Repository name', type a repository name that matches your GitHub username. For example, if your username is 'octocat', the repository name must be 'octocat'.
Optionally, add a description of your repository. For example, 'My personal repository.'
Select Public.
Select Initialize this repository with a README.
Click Create repository.
Above the right sidebar, click Edit README.
The generated README file is pre-populated with a template to give you some inspiration for your profile README.
For a summary of all the available emojis and their codes, see 'Emoji cheat sheet.'
Removing a profile README
The profile README is removed from your GitHub profile if any of the following apply:
- The README file is empty or doesn't exist.
- The repository is private.
- The repository name no longer matches your username.
The method you choose depends upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see 'Changing a repository's visibility.'
Further reading
| REST/CRUD conventions from http://project.ioni.st/post/2283#snippet_2283 |
Best Github Readme
| classAccountsController < ApplicationController |
| set_resource:account |
| defindex |
| @accounts=Account.all |
| default_formats_for@accounts |
| end |
| defshow |
| default_formats_for@account |
| end |
| end |
Git Readme Template
How To Write Readme Github
| classApplicationController < ActionController::Base |
| defself.set_resource(resource, &custom_setter) |
| filter_name=:'set_#{resource}' |
| before_filterfilter_name, |
| :only=>[:show,:edit,:update,:destroy] |
| ifcustom_setter |
| define_method(filter_name)do |
| custom_setter.call(resource) |
| end |
| else |
| define_method(filter_name)do |
| instance_variable_set( |
| '@#{resource}', |
| resource.to_s.classify.find(params[:id]) |
| ) |
| end |
| end |
| end |
| defself.default_formats_for(data) |
| respond_todo |format| |
| format.html |
| format.xml{render:xml=>data} |
| end |
| end |
| end |
Format Readme Github File