Add installation and setup instructions for Git

0Miles · Dec 22, 2023 · ba93011 · ba93011
1 parent ae2a434
commit ba93011
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,18 @@
 # SokuSourceEditor
+Used for editing the mod source for the [SokuLauncher](https://github.com/0Miles/soku-launcher) mod store, managing and publishing mods on the source.  
 
-## Install
+![preview](./docs/preview.png)
+
+## Install Git  
+This tool requires [git](https://git-scm.com/), please install it and complete the basic setup.
+1. Refer to [https://git-scm.com/downloads](https://git-scm.com/downloads) for the completion of the git installation.
+2. To set up your name and email in git
+```shell
+$ git config --global user.name "Your Name"
+$ git config --global user.email "[email protected]"
+```
+
+## Dev
 Clone and install dependencies:
 
 ```bash

diff --git a/docs/preview.png b/docs/preview.png