Difference between revisions of "First-time Git setup"

From Geos-chem
Jump to: navigation, search
(Created page with "== First-time Git setup === Before using Git for the first time, you need to set up your <tt>~/.gitconfig</tt> file. This will set some global parameters, such as your name...")
 
(First-time Git setup =)
Line 1: Line 1:
== First-time Git setup ===
+
== Overview ===
  
 
Before using Git for the first time, you need to set up your <tt>~/.gitconfig</tt> file.  This will set some global parameters, such as your name and email, and the external editor that you wish to use with Git.
 
Before using Git for the first time, you need to set up your <tt>~/.gitconfig</tt> file.  This will set some global parameters, such as your name and email, and the external editor that you wish to use with Git.
 +
 +
Once you have defined your <tt>~/.gitconfig</tt> file, you can copy it any other computer systems where you use Git.  That will ensure that you have the same identity and settings across all systems.
  
 
=== By editing the .gitconfig file ===
 
=== By editing the .gitconfig file ===
Line 25: Line 27:
 
  git config --global user.email you@yourdomain.example.com
 
  git config --global user.email you@yourdomain.example.com
 
  git config --global core.editor emacs
 
  git config --global core.editor emacs
 +
 +
== Further reading ==
 +
 +
#[https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration ''Git configuration'' (Official Git documentation)]
 +
#[https://docs.scipy.org/doc/numpy-1.6.0/dev/gitwash/configure_git.html ''Git configuration'' (Numpy documentation)]

Revision as of 14:42, 19 June 2019

Overview =

Before using Git for the first time, you need to set up your ~/.gitconfig file. This will set some global parameters, such as your name and email, and the external editor that you wish to use with Git.

Once you have defined your ~/.gitconfig file, you can copy it any other computer systems where you use Git. That will ensure that you have the same identity and settings across all systems.

By editing the .gitconfig file

Open a text editor and then cut & paste the text from this sample .gitconfig file.

[user]
        name = Your Name
        email = you@yourdomain.example.com
 
[core]
        editor = emacs

There are other settings you can add, but these are the absolute minimum that you need. Be sure to change your name and email accordingly, this is how Git will know who you are!

When you are done editing the file, save it as ~/.gitconfig.

Or by using the git config command

If you do not wish to manually edit the the ~/.gitconfig file, you can define the same settings by using the git config --global command:

git config --global user.name "Your Name"
git config --global user.email you@yourdomain.example.com
git config --global core.editor emacs

Further reading

  1. Git configuration (Official Git documentation)
  2. Git configuration (Numpy documentation)