summaryrefslogtreecommitdiff
path: root/index.markdown
blob: ae05348fe7acecdd3bbe3e4547f70438444fe97f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
---
layout: default
title: Welcome
---

Welcome to the GitHub Help site. Here we have compiled many guides to help you set up and use git and GitHub.

Use the sidebar on the right side of this site to access our guides!

If you would like to submit your own guides, please fork [our repo](http://github.com/github/help.github.com/) and send pull requests to [tekkub](http://github.com/tekkub)

*We are in the process of moving guides over from the [old wiki](http://github.com/guides/home).*

Getting started with Git and GitHub
-----------------------------------

Getting up and running from scratch is easy:

1. [Install Git](git-installation-redirect)
2. [Generate a keypair](key-setup-redirect) -- *[If you have troubles](troubleshooting-ssh)*
3. [Set your user and email in git](git-email-settings)
4. [Create a repo](creating-a-repo) or "fork an existing repo](forking)

After you've created a repo you will presented with the commands necessary to create a new empty repo locally, push an existing local repo, or import an SVN repo.

If you are collaborating on someone else's repo, you can clone the repo using the command `git clone git@github.com:username/reponame.git`.  You can find this clone URL in the repo's header when viewing its source page.

To learn more about git's commands, we highly recommend you check out the [Pro Git book](http://progit.org/) and the [git man pages](http://www.kernel.org/pub/software/scm/git/docs/).  If you need help or have any questions, feel free to [contact support](http://support.github.com) or [ask the community](http://groups.google.com/group/github/).

Popular guides
--------------

<dl>
  {% for post in site.posts reversed %}{% if post.categories contains "popular" %}
    <dt><a href="{{ post.url }}" id="{{ cat }}">{{ post.title }}</a></dt>
    <dd>{{ post.description }}</dd>
  {% endif %}{% endfor %}
</dl>

Getting help
------------

There are a number of resources available to help you learn git or fix issues with GitHub:

### GitHub

* [GitHub Support](http://support.github.com) -- Resolve issues with GitHub or get help with basic git issues.
* [Contact GitHub](http://github.com/contact) -- Don't feel like making an account on support.github.com?  This is your direct line to us.
* [GitHub Google Group](http://groups.google.com/group/github/) -- Ask the community for help
* [GitHub Status](http://twitter.com/github) -- Is GitHub down, or is it just me?

### Git

* [Pro Git](http://progit.org/)
* [git-scm](http://git-scm.com/)
* [git man pages](http://www.kernel.org/pub/software/scm/git/docs/) -- In-depth documentation for every git command.
* [git user's manual](http://www.kernel.org/pub/software/scm/git/docs/user-manual.html)
* [Learn.GitHub](http://learn.github.com) -- Git tutorials for beginners and experts.
* [git ready](http://www.gitready.com/) -- Little tips and hints for using git.