Gitinfo

rjleveque edited this page Aug 6, 2011 · 11 revisions
Clone this wiki locally

Git Information

See also: GitHub Plan for information about how Clawpack will be organized on GitHub.

Fernando Perez's blog http://fperez.org/py4science/git.html has many other useful links to get started.

Git references

If you have Git installed, you can also do ($ is the unix prompt):

$ git --help
$ git commit --help   # for help about the commit command.

To download source code or view the wiki

  • You can download a tar or zip directory of any public repository without creating an account or having Git on your computer. Navigate to the repository, e.g. https://github.com/clawpack/doc and then click on "Downloads". If you don't see the "Downloads" button, click first on "Source". You can also click on "Wiki" to view any wiki pages associated with this project.

To install Git

Quick guide to getting started with Git and GitHub

  • To clone your own copy of a project (once you have git installed), go to the "Source" page for the project and copy the HTTP line that looks something like https://github.com/clawpack/doc.git. To clone this particular repository:

    $ git clone https://github.com/clawpack/doc.git

  • This allows you to do

    $ git pull

To fetch any changes in the repository and merge them into your clone. (See also the Git resources for information on fetching and merging separately.)

If you want to be able to push changes or edit wiki pages, you will need an account on GitHub:

  • Go to https://github.com/, click on "Plans, pricing, and Signup" and then on "Create a free account"

  • Follow the instructions to create and account, to install Git on your machine, and to copy the ssh info needed by GitHub if you ever want to push something to a repository.

  • If you prefer using Mercurial, see http://hg-git.github.com/.

  • Once you're logged into github.com, you can click on "Dashboard" to get to the list of your own repositories.

  • If you are a Clawpack developer who is on one of the GitHub Clawpack Organization Teams, you should also be able to click on "Switch context" from your Dashboard and then click on "Clawpack" to see the Clawpack repositories that you have push permission for.

Developers

Rather than cloning a clawpack repository directly, it is better to fork the repository to your own Github account, clone that version to make you changes, and then issue a pull request if you want your changes merged into the main clawpack repository.