From a7f609d479aede65a69fbb1f0f38889a002e1d72 Mon Sep 17 00:00:00 2001
From: leo <longshuang@msn.cn>
Date: Fri, 27 Sep 2024 13:52:39 +0800
Subject: [PATCH] readme: add description for build

---
 build/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 build/README.md

diff --git a/build/README.md b/build/README.md
new file mode 100644
index 00000000..a75f4d73
--- /dev/null
+++ b/build/README.md
@@ -0,0 +1,15 @@
+# build
+
+> [!WARNING]
+> The files under the `build` folder is used for `Github Action` only, **NOT** for end users.
+
+## How to build this project manually
+
+1. Make sure [.NET SDK 8](https://dotnet.microsoft.com/en-us/download) is installed on your machine.
+2. Clone this project
+3. Run the follow command under the project root dir
+```sh
+dotnet publish -c Release -r $RUNTIME_IDENTIFIER -o $DESTINATION_FOLDER src/SourceGit.csproj
+```
+> [!NOTE]
+> Please replace the `$RUNTIME_IDENTIFIER` with one of `win-x64`,`win-arm64`,`linux-x64`,`linux-arm64`,`osx-x64`,`osx-arm64`, and replece the `$DESTINATION_FOLDER` with the real path that will store the output executable files.