• Git Readme Example
• Git Readme Formatting
• Github Readme Files
• Git Readme File Extension

The first step is to go to GitHub and create a new repository and choose to include a readme.md file, then git pull this information into your local machine for use. Once that GitHub repo is local you can then copy / paste any starter code into the repo from your GitLab repo and start working.

About README.md files.

1. It was inspired by GitHub Flavored Markdown. You can use GitLab Flavored Markdown in the following areas: Comments Issues Merge requests Milestones Snippets (the snippet must be named with a.md extension) Wiki pages Markdown documents inside repositories Epics. You can also use other rich text files in GitLab.
2. Source of: files/README.md Word Wrap View in Git #### Site static content directory This directory can be used to house site content in the form of independent files that may not be suitable for git version control.

Overview

README.md files are Markdown files that describe a directory.GitHub and Gitiles renders it when you browse the directory.

For example, the file /README.md is rendered when you view the contents of thecontaining directory:

https://github.com/google/styleguide/tree/gh-pages

Also README.md at HEAD ref is rendered by Gitiles when displaying repositoryindex:

Git Readme Example

https://gerrit.googlesource.com/gitiles/

Guidelines

README.md files are intended to provide orientation for engineers browsingyour code, especially first-time users. The README.md is likely the firstfile a reader encounters when they browse a directory thatcontains your code. In this way, it acts as a landing page for the directory.

We recommend that top-level directories for your code have an up-to-dateREADME.md file. This is especially important for package directories thatprovide interfaces for other teams.

Filename

Use README.md.

Files named README are not displayed in the directory view in Gitiles.

Contents

At minimum, every package-level README.md should include or point to thefollowing information:

1. What is in this package/library and what’s it used for.
2. Who to contact.
3. Status: whether this package/library is deprecated, or not for generalrelease, etc.
4. More info: where to go for more detailed documentation, such as:
   • An overview.md file for more detailed conceptual information.
   • Any API documentation for using this package/library.

Example

Starting today, you can create new files directly on GitHub in any of your repositories. You’ll now see a “New File” icon next to the breadcrumb whenever you’re viewing a folder’s tree listing:

Clicking this icon opens a new file editor right in your browser:

Git Readme Formatting

If you try to create a new file in a repository that you don’t have access to, we will even fork the project for you and help you send a pull request to the original repository with your new file.

This means you can now easily create README, LICENSE, and .gitignore files, or add other helpful documentation such as contributing guidelines without leaving the website—just use the links provided!

For .gitignore files, you can also select from our list of common templates to use as a starting point for your file:

Github Readme Files

ProTip™: You can pre-fill the filename field using just the URL. Typing ?filename=yournewfile.txt at the end of the URL will pre-fill the filename field with the name yournewfile.txt.

Git Readme File Extension

Enjoy!