share/WinGit/README.portable

   1 README.portable (Draft)
   2 =======================
   3
   4 This "portable" version of Git for Windows (MSysGit) does not need to
   5 be installed. It will run from any directory you place it in, even
   6 onto a USB thumbdrive. It will not write permanent entries into the
   7 Windows registry. It does not need administrator privileges to "install".
   8
   9
  10 Installation
  11 ------------
  12
  13 This package is contained in a 7-zip archive with a file name like
  14 'PortableGit-<versionstring>.7z'.  It is a self-extracting archive:
  15 add the file extension '.exe', and you can (double-)click it; you'll be
  16 asked for the desired target directory (which defaults to C:\Program
  17 Files\Git). You may change that as needed or desired. Your user account
  18 needs write access to the selected directory. (You can move that
  19 directory with all its contents to a different place or computer at any
  20 time should you later desire so).
  21
  22
  23 Functional differences to "normal" MSysGit installation package
  24 ---------------------------------------------------------------
  25
  26 This version does not offer you the convenient right-click context menu
  27 entries "Git GUI Here" and "Git Bash Here", because these would require
  28 to add entries into the Windows registry.
  29
  30
  31 Warning
  32 -------
  33
  34 Since this portable package does not modify any Windows %path%
  35 variables, it is not possible to run the git.exe and gitk.exe files
  36 directly. Start the Git Bash or Git Cmd instead, or add the cmd/ folder
  37 to your %path%.
  38
  39
  40 How to start using PortableGit
  41 ------------------------------
  42
  43 If you are comfortable with a Unix-like shell, just launch 'git-bash.bat'.
  44
  45 If not, just launch 'git-cmd.bat'.
  46
  47 Alternatively, you can execute these commands to modify the %path%
  48 variable temporarily:
  49
  50         set gitdir=c:\portablegit
  51         set path=%gitdir%\cmd;%path%
  52
  53 Adjust the 'gitdir' according to your setup.  As long as you do not
  54 close the command window, you can now simply type "git" or "gitk" to
  55 really call "c:\portablegit\cmd\git.cmd" or "c:\portablegit\cmd\gitk.cmd".
  56
  57
  58 Quick start
  59 -----------
  60
  61 Start configuring git with your personal settings:
  62         git config --global user.name "Joe Sixpack"
  63         git config --global user.email joe.sixpack@g_mail.com
  64
  65 Start using git:
  66         git --help
  67
  68
  69 How to change %path% permanently
  70 --------------------------------
  71
  72 You may also want to make the modification to the %path% variable a
  73 permanent one. The %path% variable may be changed:
  74
  75 * either on a System level (for all users in the lower pane), if you are
  76   an Administrator
  77 * or for your own user account only (in the upper pane).
  78
  79 To change the %path% variable permanently:
  80
  81 * right-click "My Computer",
  82 * select "Properties",
  83 * open "Advanced",
  84 * click "Environment Variables",
  85 * highlight the "Path" variable,
  86 * click "Edit" (either in upper or in lower pane),
  87 * add your specific path to front of "Variable value" field, separated
  88   by a semicolon from the existing entry.
  89