]> git.cworth.org Git - hgbook-git/commitdiff
Port section 2.2 (Getting started) from mercurial to git
authorCarl Worth <cworth@cworth.org>
Thu, 27 Sep 2007 23:13:25 +0000 (16:13 -0700)
committerCarl Worth <cworth@cworth.org>
Thu, 27 Sep 2007 23:13:25 +0000 (16:13 -0700)
tour.mdwn

index 2721d8007ab29dfab5e521ddc75bd26f67839587..e6429f24592acec073ac8df11b235f311b307a83 100644 (file)
--- a/tour.mdwn
+++ b/tour.mdwn
@@ -94,51 +94,36 @@ without the development environment, (still in Alpha as of September
 
 ### 2.2  Getting started
 
-To begin, we’ll use the “hg version” command to find out whether
-Mercurial is actually installed properly. The actual version
-information that it prints isn’t so important; it’s whether it prints
-anything at all that we care about.
+To begin, we’ll use the “git version” command to find out whether git
+is actually installed properly. Versions 1.5 and newer of git are much
+more friendly to new users than versions 1.4 and older. If you aren't
+yet running version 1.5 or newer, it's highly recommended that you
+upgrade.
 
-       $ hg version   
-       Mercurial Distributed SCM (version 2937d0dbfab0)   
-       
-       Copyright (C) 2005, 2006 Matt Mackall <mpm@selenic.com>   
-       This is free software; see the source for copying conditions. There is NO   
-       warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+       $ git version   
+       git version 1.5.3.2
 
 #### 2.2.1  Built-in help
 
-Mercurial provides a built-in help system. This is invaluable for
-those times when you find yourself stuck trying to remember how to run
-a command. If you are completely stuck, simply run “hg help”; it will
-print a brief list of commands, along with a description of what each
-does. If you ask for help on a specific command (as below), it prints
-more detailed information.
-
-       $ hg help init   
-       hg init [-e CMD] [--remotecmd CMD] [DEST]   
-       
-       create a new repository in the given directory   
-       
-       Initialize a new repository in the given directory.  If the given   
-       directory does not exist, it is created.   
-       
-       If no directory is given, the current directory is used.   
-       
-       It is possible to specify an ssh:// URL as the destination.   
-       Look at the help text for the pull command for important details   
-       about ssh:// URLs.   
-       
-       options:   
-       
-       -e --ssh        specify ssh command to use   
-       --remotecmd  specify hg command to run on the remote side   
-       
-       use "hg -v help init" to show global options
-
-For a more impressive level of detail (which you won’t usually need)
-run “hg help -v”. The -v option is short for --verbose, and tells
-Mercurial to print more information than it usually would.
+Git provides a built-in help system. This is invaluable for those
+times when you find yourself stuck trying to remember how to run a
+command. If you are completely stuck, simply run “git help”; it will
+print a brief list of commonly-used commands, along with a description
+of what each does. If you ask for help on a specific command (such as
+"git help init"), it prints more detailed information. [XXX: Does "git
+help <foo>" work universally as a built-in or does it expect man to be
+present and just call out to "man git-<foo>"?]
+
+       [XXX: The original hgbook includes the complete output of "hg
+       help init" at this point. I'm not including the corresponding
+       "git help init" output as it would be excessively long. The
+       description alone is quite reasonable, (other than a
+       not-too-helpful aside about the obsolete git-init-db command),
+       but it only comes after a full screen's worth of options
+       details. Might it make sense to have a more summarized help
+       output for "git help <foo>" than all of the documentation
+       available for git-<foo>? And perhaps alos provide a "git -v
+       help" similar to "hg -v help" for more?]
 
 ### 2.3  Working with a repository