doc: add new Git tutorial for beginners Introduce Git in two parts: Steps 1-7: Create an empty repo & make 2 commits (`git init`, `git add`, `git commit`, `git status`, `git diff`) Steps 8-12: Push the repo to a remote host like GitHub or GitLab (`git remote add`, `git push`) Some design choices: - Only use commands present in 2.23.0 (when `git switch` as introduced), to support older versions of Git. - Introduce a much smaller set of commands than the old tutorial, to keep the tutorial quick (doable in an hour). Some users found it to be very fast and some wanted to stop early (after step 7) so this seems to be a good balance. - Have users start with an empty repository instead of an existing project, because many of the testers did not have an existing project to test, or were scared of using an existing project. - Add a troubleshooting section, since in the testing some users got extremely stuck (for 4+ hours) on minor issues like needing to say "yes" when SSHing to a new host. - Don't explain branches, because explaining branches and collaboration is complicated and deserves its own tutorial. Instead just tell users we're not going to explain them in this document. - Tell users to set their default branch to `main`, because many Git hosts use it as their default branch and it really simplifies things. - Keep it as vendor neutral as possible, while acknowledging the reality that Git hosting services like GitHub, GitLab, etc are extremely popular. Do this by creating the repo locally and then optionally pushing it later. - Use SSH for authentication, explaining how to set up SSH in the easiest way possible (with disclaimers to check your security team's policy if applicable since the "easiest way" may not be the best), and giving some instructions for how to translate an HTTPS URL to an SSH URL. - Use Git Credential Manager for authentication on Windows, since it's simpler, SSH auth is a very "unixy" thing to do, and GCM comes with Git for Windows - Warn people about how `vi` is the default text editor and give some instructions for how to escape At least 20 people have successfully completed it, and feedback was incorporated from problems the testers ran into. Helped-by: D. Ben Knoble <ben.knoble@gmail.com> Co-authored-by: Marie Claire LeBlanc Flanagan <hello@marieflanagan.com> Signed-off-by: Marie Claire LeBlanc Flanagan <hello@marieflanagan.com> Signed-off-by: Julia Evans <julia@jvns.ca> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals.
Git is an Open Source project covered by the GNU General Public License version 2 (some parts of it are under different licenses, compatible with the GPLv2). It was originally written by Linus Torvalds with help of a group of hackers around the net.
Please read the file INSTALL for installation instructions.
Many Git online resources are accessible from https://git-scm.com/ including full documentation and Git related tools.
See Documentation/gittutorial.adoc to get started, then see Documentation/giteveryday.adoc for a useful minimum set of commands, and Documentation/git-<commandname>.adoc for documentation of each command. If git has been correctly installed, then the tutorial can also be read with man gittutorial or git help tutorial, and the documentation of each command with man git-<commandname> or git help <commandname>.
CVS users may also want to read Documentation/gitcvs-migration.adoc (man gitcvs-migration or git help cvs-migration if git is installed).
The user discussion and development of Git take place on the Git mailing list -- everyone is welcome to post bug reports, feature requests, comments and patches to git@vger.kernel.org (read Documentation/SubmittingPatches for instructions on patch submission and Documentation/CodingGuidelines).
Those wishing to help with error message, usage and informational message string translations (localization l10) should see po/README.md (a po file is a Portable Object file that holds the translations).
To subscribe to the list, send an email to git+subscribe@vger.kernel.org (see https://subspace.kernel.org/subscribing.html for details). The mailing list archives are available at https://lore.kernel.org/git/, https://marc.info/?l=git and other archival sites.
Issues which are security relevant should be disclosed privately to the Git Security mailing list git-security@googlegroups.com.
The maintainer frequently sends the “What's cooking” reports that list the current status of various development topics to the mailing list. The discussion following them give a good reference for project status, development direction and remaining tasks.
The name “git” was given by Linus Torvalds when he wrote the very first version. He described the tool as “the stupid content tracker” and the name as (depending on your mood):