From ec224bebcb8b1ef79f5fdd35e50f53100d2ce07f Mon Sep 17 00:00:00 2001 From: leo Date: Sun, 21 Jul 2024 18:05:50 +0800 Subject: [PATCH] readme: add tips for Windows users to install this app --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2ea6ebec..b5ee6783 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ Opensource Git GUI client. You can download the latest stable from [Releases](https://github.com/sourcegit-scm/sourcegit/releases/latest) or download workflow artifacts from [Github Actions](https://github.com/sourcegit-scm/sourcegit/actions) to try this app based on latest commits. -This software creates a folder `$"{System.Environment.SpecialFolder.ApplicationData}/SourceGit"`, which is platform-dependent, to store user settings, downloaded avatars and crash logs. +This software creates a folder `$"{System.Environment.SpecialFolder.ApplicationData}/SourceGit"`, which is platform-dependent, to store user settings, downloaded avatars and crash logs. | OS | PATH | |---------|-------------------------------------------------| @@ -52,8 +52,16 @@ This software creates a folder `$"{System.Environment.SpecialFolder.ApplicationD For **Windows** users: * **MSYS Git is NOT supported**. Please use official [Git for Windows](https://git-scm.com/download/win) instead. -* You can install the latest stable by `winget install SourceGit`. - - Note: `winget` will install this software as a commandline tool. You need run `SourceGit` from console or `Win+R` at the first time. Then you can add it to the taskbar. +* You can install the latest stable from `winget` with follow commands: + ```shell + winget install SourceGit + ``` + > `winget` will install this software as a commandline tool. You need run `SourceGit` from console or `Win+R` at the first time. Then you can add it to the taskbar. +* You can install the latest stable by `scoope` with follow commands: + ```shell + scoop bucket add extras + scoop install sourcegit + ``` * Portable versions can be found in [Releases](https://github.com/sourcegit-scm/sourcegit/releases/latest) For **macOS** users: @@ -68,7 +76,7 @@ For **Linux** users: * `xdg-open` must be installed to support open native file manager. * Make sure [git-credential-manager](https://github.com/git-ecosystem/git-credential-manager/releases) is installed on your linux. -* Maybe you need to set environment variable `AVALONIA_SCREEN_SCALE_FACTORS`. See https://github.com/AvaloniaUI/Avalonia/wiki/Configuring-X11-per-monitor-DPI. +* Maybe you need to set environment variable `AVALONIA_SCREEN_SCALE_FACTORS`. See https://github.com/AvaloniaUI/Avalonia/wiki/Configuring-X11-per-monitor-DPI. ## External Tools @@ -82,7 +90,7 @@ This app supports open repository in external tools listed in the table below. | JetBrains Fleet | YES | YES | YES | FLEET_PATH | | Sublime Text | YES | YES | YES | SUBLIME_TEXT_PATH | -* You can set the given environment variable for special tool if it can NOT be found by this app automatically. +* You can set the given environment variable for special tool if it can NOT be found by this app automatically. * Installing `JetBrains Toolbox` will help this app to find other JetBrains tools installed on your device. * On macOS, you may need to use `launchctl setenv` to make sure the app can read these environment variables.