Skip to content

Commit

Permalink
Rewrite git installation instructions page
Browse files Browse the repository at this point in the history
Also addresses incorrect winget CLI command in the installation
instructions.

Fixes #81
  • Loading branch information
rcdailey committed Jan 9, 2025
1 parent 5c680d7 commit 8d2a830
Showing 1 changed file with 55 additions and 25 deletions.
80 changes: 55 additions & 25 deletions docs/installation/tips/git-install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,78 @@ id: git-install
title: Install Git on Windows
---

This is a walkthrough for installing Git on Windows.
This guide will walk you through the process of installing Git on Windows. Git is essential for
running Recyclarr, as it's used to download and update the application.

## Installation
## Quick Start

Using [Winget CLI](https://winget.run/pkg/Git/Git):
For those familiar with package managers, you can quickly install Git using one of the following
methods:

```cmd
winget install git
```
- Using [Winget CLI](https://git-scm.com/downloads/win):

Using [Chocolatey](https://community.chocolatey.org/packages/git):
```cmd
winget install --id Git.Git -e --source winget
```

```cmd
choco install git
```
- Using [Chocolatey](https://community.chocolatey.org/packages/git):

```cmd
choco install git
```

Or use the official [Git for Windows installer](https://gitforwindows.org/). If you decide to use
the installer, see the section below for important installation instructions.
If you prefer a more guided approach or don't use package managers, continue reading for detailed
instructions using the official Git installer.

### Git for Windows Installer
## Detailed Installation Guide

### Using the Git for Windows Installer

:::info

Skip this section if you're using Chocolatey or Winget methods.
Skip this section if you've already installed Git using Winget or Chocolatey.

:::

:::warning
1. Download the official [Git for Windows installer](https://gitforwindows.org/).

Before proceeding, **close any open terminal windows** such as Powershell and CMD/Command Prompt.
The Git installer will modify your `PATH` environment variable. Terminals will not reload updates to
this variable while they are open!
2. Before running the installer, close any open terminal windows (PowerShell, CMD, etc.). This is
important because the installer will modify your `PATH` environment variable, and open terminals
won't reflect these changes.

:::
3. Run the downloaded installer.

4. During the installation wizard, you can keep all options at their default settings for a standard
installation.

5. Pay special attention to the following page in the wizard:

![Git Setup Add Path](/doc-img/git-setup-add-path.png)

1. Download and run the installer from [here](https://gitforwindows.org/).
Ensure that the option "Git from the command line and also from 3rd-party software" is selected.
This should be the default choice.

1. During the installation wizard, keep all options at their defaults.
6. Complete the installation process.

1. When you reach the page of the wizard pictured below, ensure that the shown option is selected
(again, this should be selected by default):
### Verifying the Installation

![img](/doc-img/git-setup-add-path.png)
After installation, you can verify that Git is correctly installed by opening a new terminal window
and running:

1. Once the installer completes, you should be able to run Recyclarr.
```cmd
git --version
```

If Git is properly installed, this command will display the installed version of Git.

## Next Steps

With Git successfully installed, you're now ready to use Recyclarr. If you haven't already, check
out our [Getting Started](getting-started.mdx) guide to begin using Recyclarr.

:::tip

Remember to always use a new terminal window after installing Git to ensure that your system
recognizes the new installation.

:::

0 comments on commit 8d2a830

Please sign in to comment.