From f92858994a980daabae88b7e3c029e33fdd7d44d Mon Sep 17 00:00:00 2001 From: leo Date: Wed, 24 Apr 2024 22:07:48 +0800 Subject: [PATCH] readme: add description for folder that created by this app to store user settings, downloaded avatars and crash logs. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d759ef6b..b2307580 100644 --- a/README.md +++ b/README.md @@ -28,12 +28,20 @@ Opensource Git GUI client. > **Linux** only tested on **Ubuntu 22.04** on **X11**. -## How to use +## How to Use **To use this tool, you need to install Git(>=2.23.0) first.** 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. + +| OS | PATH | +| --- | --- | +| Windows | `C:\Users\USER_NAME\AppData\Roaming\SourceGit` | +| Linux | `/home/USER_NAME/.config/SourceGit` | +| macOS | `/Users/USER_NAME/.config/SourceGit` | + For **Windows** users: * **MSYS Git is NOT supported**. Please use official [Git for Windows](https://git-scm.com/download/win) instead.