From 7ea5e480e701554826d4cb759fa2be55ba93537d Mon Sep 17 00:00:00 2001
From: Clement <gh.2lgqz@aleeas.com>
Date: Fri, 29 Sep 2023 01:31:09 +0800
Subject: [PATCH] chore: update CONTRIBUTING.md

---
 CONTRIBUTING.md | 31 +++++++++++++++++++++++++------
 README.md       |  2 +-
 2 files changed, 26 insertions(+), 7 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f4b473e..9718088 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,47 +1,66 @@
 # How to contribute
 
-The Talk project has been split into two repositories: [talk](https://github.com/proxoar/talk.git) and [talk-web](https://github.com/proxoar/talk-web.git).
+The Talk project has been split into two repositories: [talk](https://github.com/proxoar/talk.git)
+and [talk-web](https://github.com/proxoar/talk-web.git).
+
+In the process of building, the backend incorporates static site files and produces a standalone executable binary that
+operates independently without any external dependencies.
 
 ## Clone projects
+
 ```shell
 git clone https://github.com/proxoar/talk.git proxoar/talk
 git clone https://github.com/proxoar/talk-web.git proxoar/talk-web
 ```
 
 ## Run
+
 ### Backend
-I. Install [Go](https://go.dev/dl/) v1.21 or higher 
 
-II. Start the backend server(prepare your [`talk.yaml`](README.md/#how-to-use) before starting)
+I. Install [Go](https://go.dev/dl/) v1.21 or higher
+
+II. Start the backend server
+(prepare your [`talk.yaml`](README.md/#how-to-use) before starting)
 ```shell
 # in proxoar/talk
 make run
 ```
-The backend server listens on `localhost:8000` 
 
-###  Frontend
-I. Install [Node](https://nodejs.org/en/download/current) v20 or higher 
+The backend server listens on `localhost:8000`
+
+### Frontend
+
+I. Install [Node](https://nodejs.org/en/download/current) v20 or higher
 
 II. Install yarn
+
 ```shell
 npm install --global yarn
 ```
+
 III. Start the WEB
+
 ```shell
 # in proxoar/talk-web
 yarn dev
 ```
+
 Open http://localhost:5173 in browser, you should see the home page.
 
 ## Build a single binary
+
 I. Build the static site and copy it to `proxoar/talk`
+
 ```shell
 # in proxoar/talk-web
 make copy
 ```
+
 II. Build backend
+
 ```shell
 # in proxoar/talk
 make build
 ``` 
+
 An executive binary `talk` will be created
diff --git a/README.md b/README.md
index 4fe27de..3a88156 100644
--- a/README.md
+++ b/README.md
@@ -181,7 +181,7 @@ Engine, with certain limitations on browsers such as Safari.
 
 We're in the midst of a dynamic development stage for this project and warmly invite new contributors.
 
-Doc for contributing will be ready soon.
+[CONTRIBUTING.md](CONTRIBUTING.md)
 
 # Credits