Skip to content

Latest commit

 

History

History
121 lines (93 loc) · 6.66 KB

2008-01-02-create-a-repo.markdown

File metadata and controls

121 lines (93 loc) · 6.66 KB
Raw
layout title description categories
default
Create A Repo
Create the place where your commits will be stored
beginner

If you’ve found yourself on this page, we’re assuming you’re brand new to Git and GitHub. This guide will walk you through the basics and explain a little bit about how everything works along the way.

##First: Create A Repo

Every time you make a commit with Git, it is stored in a repository (a.k.a. “repo”). To put your project up on GitHub, you’ll need to have a GitHub repository for it to live in.

More about repositories

Git stores all of your project files in a repository. If you are able to view hidden files on your system, you’ll see a subdirectory called “.git” in the project directory where you ran git init. This is where Git stores all of your commits, as well as everything else it needs. In addition to your local repo, you can also have remote repositories (like GitHub repos). Remote repositories are the same as your local repo, but stored on a different server or computer for easy collaboration, backup, and general awesomeness.

  1. Create a new repo

    <p>Click <a href="https://github.com/repositories/new">New Repository</a>.</p>

<img src="/images/bootcamp/bootcamp_2_newrepo.jpg" width="558" height="291" alt="Click &ldquo;New Repository" />

<p>Fill out the information on this page. When you&rsquo;re done, click &ldquo;Create Repository.&rdquo;</p>

<img src="/images/bootcamp/bootcamp_2_repoinfo.jpg" width="558" height="437" alt="Fill in the info" />

<p>Congratulations! You have successfully created your first repo!</p>

##Next: Create a README for your repo.

While a README isn’t a required part of a GitHub repo, it is a good idea to have one. READMEs are a great place to describe your project or add some documentation such as how to install or use your project.

More about READMEs

If you include a file with the filename “README” in your repo, it will automatically be shown on your repo’s front page. Pretty cool, huh? GitHub supports a number of different README formats. The one in this tutorial will result in a basic text file but other formats like .markdown or .textile can be used to render HTML content like links and headers. For more info about the supported markup formats, check out the github markup repo.

  1. Create the README file

    <p>In the prompt, type the following code:</p>

<pre class="terminal bootcamp">
<span class="codeline">$ mkdir ~/Hello-World<span>Creates a directory for your project called "Hello-World" in your user directory</span></span>
<span class="codeline">$ cd ~/Hello-World<span>Changes the current working directory to your newly created directory</span></span>
<span class="codeline">$ git init<span>Sets up the necessary Git files</span></span>
<span class="bash-output">Initialized empty Git repository in /Users/<em>your_user_directory</em>/Hello-World/.git/</span>
<span class="codeline">$ touch README<span>Creates a file called &ldquo;README&rdquo; in your Hello-World directory</span></span>
</pre>

<p>Open the new README file found in your Hello-World directory in a text editor and add the text &ldquo;Hello World!&rdquo; When you are finished, save and close the file.</p>

  2. Commit your README

    <p>Now that you have your README set up, it&rsquo;s time to commit it. A commit is essentially a snapshot of all the files in your project at a particular point in time. In the prompt, type the following code:</p>

<div class="more-info">
  <h4 class="compressed">More about commits</h4>
  <div class="more-content">
    <p>
      Think of a <em>commit</em> as a snapshot of your project &mdash; code, files, everything &mdash; at a particular point in time. More accurately, after your first commit, each subsequent commit is only a snapshot of your changes. For code files, this means it only takes a snapshot of the lines of code that have changed. For everything else like music or image files, it saves a new copy of the file.
    </p>
  </div>
</div>

<pre class="terminal bootcamp">
<span class="codeline">$ git add README<span>Stages your README file, adding it to the list of files to be committed</span></span>
<span class="codeline">$ git commit -m 'first commit'<span></span>Commits your files, adding the message "first commit"</span>
</pre>

<p>The code above executes actions locally, meaning you still haven&rsquo;t done anything on GitHub yet. To connect your local repository to your GitHub account, you will need to set a remote for your repo and push your commits to it:</p>

<div class="more-info">
  <h4 class="compressed">More about remotes</h4>
  <div class="more-content">
    <p>
      A <em>remote</em> is a repo stored on another computer, in this case on GitHub&rsquo;s server. It is standard practice (and also the default in some cases) to give the name <code>origin</code> to the remote that points to your main offsite repo (for example, your GitHub repo).
    </p>
    <p>
      Git supports multiple remotes. This is commonly used when forking a repo.
    </p>
  </div>
</div>

<pre class="terminal bootcamp">
<span class="codeline">$ git remote add origin git@github.com:<em>username</em>/Hello-World.git<span>Sets the origin for the Hello-World repo</span></span>
<span class="codeline">$ git push -u origin master<span></span>Sends your commit to GitHub</span>
</pre>

<p>Now if you look at your repository on GitHub, you will see your README has been added to it.</p>

<img src="/images/bootcamp/bootcamp_2_updatedreadme.jpg" width="558" height="577" alt="Your README has been created" />

##Lastly: Celebrate

Congratulations! You have now created a repository on GitHub, created a README, committed it, and pushed it to GitHub. What do you want to do next?

  1. Set Up Git
  2. Create A Repository
  3. Fork A Repository
  4. Be Social