github / training-kit

Open source courseware for Git and GitHub
https://github.github.com/training-kit/
Creative Commons Attribution 4.0 International
4.27k stars 4.33k forks source link

Documentation unclear surrounding GitHub Desktop installation and its inclusion (or not) of Git #920

Open spikysimonw opened 1 year ago

spikysimonw commented 1 year ago

Overview

TL;DR Confusing and misleading information on a) whether or not Git is included as part of a GitHub Desktop install, and b) whether Git is already installed on "most versions of MacOS".

Extra Detail

Screenshots

Link A - https://github.com/github/training-kit/blob/master/git-guides/install-git.md#install-git-using-github-desktop Link B - https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop#part-3-configuring-git Link C - https://github.com/github/training-kit/blob/master/git-guides/install-git.md#install-git-on-mac

Reasoning

Testing suggests a local git install does not get installed as part of an official GitHub Desktop installation on macOS, however instead it seems some form of sandboxed implementation is included (?) as within the GitHub Desktop app itself it can perform git operations without any local git install being available. Suggest this needs to be clarified and documented, ie. if and/or when a separate local installation of git is required.

MagnusOxlund commented 6 months ago

GitHub Desktop for macOS does in fact come with git. It's located inside the application package at GitHub Desktop.app/Contents/Resources/app/git/bin/git. It doesn't seem to be configured for direct CLI use, however. For instance, issuing a git clone will complain about a missing templates directory:

warning: templates not found in //share/git-core/templates

ktbyers commented 5 months ago

Yeah, I thought this was very confusing as well.