v2.2.x 文档

beego · May 15, 2024 · c26b7d6 · c26b7d6
1 parent b8e9856
commit c26b7d6
Show file tree

Hide file tree

Showing 290 changed files with 16,349 additions and 22 deletions.
diff --git a/docs/img/bee_version.png → docs/en-US/developing/qa/img/bee_version.png b/docs/img/bee_version.png → docs/en-US/developing/qa/img/bee_version.png
diff --git a/docs/img/qa/copy_request_body_false.png → ...ing/qa/img/qa/copy_request_body_false.png b/docs/img/qa/copy_request_body_false.png → ...ing/qa/img/qa/copy_request_body_false.png
diff --git a/docs/img/qa/copy_request_body_true.png → ...ping/qa/img/qa/copy_request_body_true.png b/docs/img/qa/copy_request_body_true.png → ...ping/qa/img/qa/copy_request_body_true.png
diff --git a/docs/en-US/developing/qa/what-is-copy-request-body.md b/docs/en-US/developing/qa/what-is-copy-request-body.md
@@ -39,7 +39,7 @@ func (m *MainController) ReadDataFromBody() {
 ```
 
 When we access `localhost:8080` and pass in the parameters, we can get the response:
-![CopyRequestBody=true](../../../img/qa/copy_request_body_true.png)
+![CopyRequestBody=true](./img/qa/copy_request_body_true.png)
 
 If we set `CopyRequestBody` to `false`:
 
@@ -68,7 +68,7 @@ func (m *MainController) ReadDataFromBody() {
 ```
 
 Then we will find that we cannot read the data from inside the request body:
-![CopyRequestBody=false](../../../img/qa/copy_request_body_false.png)
+![CopyRequestBody=false](./img/qa/copy_request_body_false.png)
 
 So, be aware that you should set `CopyRequestBody` to `true` if you intend to rely on Beego to process the request.
 

diff --git a/docs/en-US/v2.0.x/qa/README.md b/docs/en-US/v2.0.x/qa/README.md
@@ -1,7 +1,6 @@
 ---
 title: Q & A
 lang: en-US
-sidebar: auto
 ---
 
 # Q & A
@@ -10,7 +9,7 @@ We use a lot of commands when answering these questions. In case you find that y
 
 For Windows platforms, we strongly recommend using WSL.
 
-## Web Module
+## FAQ - Frequently Asked Questions
 
 - [Why did the web server fail to start?](failed_to_start_web_server.md)
 - [What to choose as the receiver for the Controller methods](./choose_func_recever_for_web.md)

diff --git a/docs/en-US/v2.0.x/qa/failed_to_start_web_server.md b/docs/en-US/v2.0.x/qa/failed_to_start_web_server.md
@@ -1,9 +1,9 @@
 ---
-title: hy did the web server fail to start?
+title: Why did the web server fail to start?
 lang: en-US
 ---
 
-## hy did the web server fail to start?
+## Why did the web server fail to start?
 
 The reasons for web server startup can be varied. Generally speaking, it fails because there is a problem with the local environment. web server startup failure generally consists of two parts.
 

diff --git a/docs/en-US/v2.0.x/qa/img/bee_version.png b/docs/en-US/v2.0.x/qa/img/bee_version.png
diff --git a/docs/en-US/v2.0.x/qa/img/qa/copy_request_body_false.png b/docs/en-US/v2.0.x/qa/img/qa/copy_request_body_false.png
diff --git a/docs/en-US/v2.0.x/qa/img/qa/copy_request_body_true.png b/docs/en-US/v2.0.x/qa/img/qa/copy_request_body_true.png
diff --git a/docs/en-US/v2.0.x/qa/what-is-copy-request-body.md b/docs/en-US/v2.0.x/qa/what-is-copy-request-body.md
@@ -3,7 +3,7 @@ title: What does CopyRequestBody mean?
 lang: en-US
 ---
 
-# CWhat does CopyRequestBody mean?
+# What does CopyRequestBody mean?
 
 In the Beego web configuration, there is a very confusing parameter called `CopyRequestBody`. It is in the structure `web.Config`.
 
@@ -39,7 +39,7 @@ func (m *MainController) ReadDataFromBody() {
 ```
 
 When we access `localhost:8080` and pass in the parameters, we can get the response:
-![CopyRequestBody=true](../../../img/qa/copy_request_body_true.png)
+![CopyRequestBody=true](./img/qa/copy_request_body_true.png)
 
 If we set `CopyRequestBody` to `false`:
 
@@ -68,7 +68,7 @@ func (m *MainController) ReadDataFromBody() {
 ```
 
 Then we will find that we cannot read the data from inside the request body:
-![CopyRequestBody=false](../../../img/qa/copy_request_body_false.png)
+![CopyRequestBody=false](./img/qa/copy_request_body_false.png)
 
 So, be aware that you should set `CopyRequestBody` to `true` if you intend to rely on Beego to process the request.
 

diff --git a/docs/en-US/v2.1.0/README.md → docs/en-US/v2.1.x/README.md b/docs/en-US/v2.1.0/README.md → docs/en-US/v2.1.x/README.md
diff --git a/docs/en-US/v2.1.0/bee/README.md → docs/en-US/v2.1.x/bee/README.md b/docs/en-US/v2.1.0/bee/README.md → docs/en-US/v2.1.x/bee/README.md
diff --git a/docs/en-US/v2.1.0/bee/env.md → docs/en-US/v2.1.x/bee/env.md b/docs/en-US/v2.1.0/bee/env.md → docs/en-US/v2.1.x/bee/env.md
diff --git a/docs/en-US/v2.1.0/bee/img/bee_test.png → docs/en-US/v2.1.x/bee/img/bee_test.png b/docs/en-US/v2.1.0/bee/img/bee_test.png → docs/en-US/v2.1.x/bee/img/bee_test.png
diff --git a/docs/en-US/v2.1.0/bee/img/beerun.png → docs/en-US/v2.1.x/bee/img/beerun.png b/docs/en-US/v2.1.0/bee/img/beerun.png → docs/en-US/v2.1.x/bee/img/beerun.png
diff --git a/docs/en-US/v2.1.0/bee/img/env1.png → docs/en-US/v2.1.x/bee/img/env1.png b/docs/en-US/v2.1.0/bee/img/env1.png → docs/en-US/v2.1.x/bee/img/env1.png
diff --git a/docs/en-US/v2.1.0/bee/img/env2.png → docs/en-US/v2.1.x/bee/img/env2.png b/docs/en-US/v2.1.0/bee/img/env2.png → docs/en-US/v2.1.x/bee/img/env2.png
diff --git a/docs/en-US/v2.1.0/bee/img/env3.png → docs/en-US/v2.1.x/bee/img/env3.png b/docs/en-US/v2.1.0/bee/img/env3.png → docs/en-US/v2.1.x/bee/img/env3.png
diff --git a/docs/en-US/v2.1.0/cache/README.md → docs/en-US/v2.1.x/cache/README.md b/docs/en-US/v2.1.0/cache/README.md → docs/en-US/v2.1.x/cache/README.md
diff --git a/docs/en-US/v2.1.0/cache/cache_pattern.md → docs/en-US/v2.1.x/cache/cache_pattern.md b/docs/en-US/v2.1.0/cache/cache_pattern.md → docs/en-US/v2.1.x/cache/cache_pattern.md
diff --git a/docs/en-US/v2.1.0/config/README.md → docs/en-US/v2.1.x/config/README.md b/docs/en-US/v2.1.0/config/README.md → docs/en-US/v2.1.x/config/README.md
diff --git a/docs/en-US/v2.1.0/environment/README.md → docs/en-US/v2.1.x/environment/README.md b/docs/en-US/v2.1.0/environment/README.md → docs/en-US/v2.1.x/environment/README.md
diff --git a/...n-US/v2.1.0/environment/go_get_command.md → ...n-US/v2.1.x/environment/go_get_command.md b/...n-US/v2.1.0/environment/go_get_command.md → ...n-US/v2.1.x/environment/go_get_command.md
diff --git a/docs/en-US/v2.1.0/environment/go_mod.md → docs/en-US/v2.1.x/environment/go_mod.md b/docs/en-US/v2.1.0/environment/go_mod.md → docs/en-US/v2.1.x/environment/go_mod.md
diff --git a/...US/v2.1.0/environment/install_go_linux.md → ...US/v2.1.x/environment/install_go_linux.md b/...US/v2.1.0/environment/install_go_linux.md → ...US/v2.1.x/environment/install_go_linux.md
diff --git a/...n-US/v2.1.0/environment/install_go_mac.md → ...n-US/v2.1.x/environment/install_go_mac.md b/...n-US/v2.1.0/environment/install_go_mac.md → ...n-US/v2.1.x/environment/install_go_mac.md
diff --git a/.../v2.1.0/environment/install_go_windows.md → .../v2.1.x/environment/install_go_windows.md b/.../v2.1.0/environment/install_go_windows.md → .../v2.1.x/environment/install_go_windows.md
diff --git a/docs/en-US/v2.1.0/i18n/README.md → docs/en-US/v2.1.x/i18n/README.md b/docs/en-US/v2.1.0/i18n/README.md → docs/en-US/v2.1.x/i18n/README.md
diff --git a/docs/en-US/v2.1.0/logs/README.md → docs/en-US/v2.1.x/logs/README.md b/docs/en-US/v2.1.0/logs/README.md → docs/en-US/v2.1.x/logs/README.md
diff --git a/docs/en-US/v2.1.0/orm/README.md → docs/en-US/v2.1.x/orm/README.md b/docs/en-US/v2.1.0/orm/README.md → docs/en-US/v2.1.x/orm/README.md
diff --git a/docs/en-US/v2.1.0/orm/cmd.md → docs/en-US/v2.1.x/orm/cmd.md b/docs/en-US/v2.1.0/orm/cmd.md → docs/en-US/v2.1.x/orm/cmd.md
diff --git a/docs/en-US/v2.1.0/orm/db.md → docs/en-US/v2.1.x/orm/db.md b/docs/en-US/v2.1.0/orm/db.md → docs/en-US/v2.1.x/orm/db.md
diff --git a/docs/en-US/v2.1.0/orm/migrations.md → docs/en-US/v2.1.x/orm/migrations.md b/docs/en-US/v2.1.0/orm/migrations.md → docs/en-US/v2.1.x/orm/migrations.md
diff --git a/docs/en-US/v2.1.0/orm/model.md → docs/en-US/v2.1.x/orm/model.md b/docs/en-US/v2.1.0/orm/model.md → docs/en-US/v2.1.x/orm/model.md
diff --git a/docs/en-US/v2.1.0/orm/orm.md → docs/en-US/v2.1.x/orm/orm.md b/docs/en-US/v2.1.0/orm/orm.md → docs/en-US/v2.1.x/orm/orm.md
diff --git a/docs/en-US/v2.1.0/orm/query_builder.md → docs/en-US/v2.1.x/orm/query_builder.md b/docs/en-US/v2.1.0/orm/query_builder.md → docs/en-US/v2.1.x/orm/query_builder.md
diff --git a/docs/en-US/v2.1.0/orm/query_m2m.md → docs/en-US/v2.1.x/orm/query_m2m.md b/docs/en-US/v2.1.0/orm/query_m2m.md → docs/en-US/v2.1.x/orm/query_m2m.md
diff --git a/docs/en-US/v2.1.0/orm/query_seter.md → docs/en-US/v2.1.x/orm/query_seter.md b/docs/en-US/v2.1.0/orm/query_seter.md → docs/en-US/v2.1.x/orm/query_seter.md
diff --git a/docs/en-US/v2.1.0/orm/raw_seter.md → docs/en-US/v2.1.x/orm/raw_seter.md b/docs/en-US/v2.1.0/orm/raw_seter.md → docs/en-US/v2.1.x/orm/raw_seter.md
diff --git a/docs/en-US/v2.1.0/orm/transaction.md → docs/en-US/v2.1.x/orm/transaction.md b/docs/en-US/v2.1.0/orm/transaction.md → docs/en-US/v2.1.x/orm/transaction.md
diff --git a/docs/en-US/v2.1.0/qa/README.md → docs/en-US/v2.1.x/qa/README.md b/docs/en-US/v2.1.0/qa/README.md → docs/en-US/v2.1.x/qa/README.md
@@ -1,7 +1,6 @@
 ---
 title: Q & A
 lang: en-US
-sidebar: auto
 ---
 
 # Q & A
@@ -10,7 +9,7 @@ We use a lot of commands when answering these questions. In case you find that y
 
 For Windows platforms, we strongly recommend using WSL.
 
-## Web Module
+## FAQ - Frequently Asked Questions
 
 - [Why did the web server fail to start?](failed_to_start_web_server.md)
 - [What to choose as the receiver for the Controller methods](./choose_func_recever_for_web.md)

diff --git a/.../v2.1.0/qa/choose_func_recever_for_web.md → .../v2.1.x/qa/choose_func_recever_for_web.md b/.../v2.1.0/qa/choose_func_recever_for_web.md → .../v2.1.x/qa/choose_func_recever_for_web.md
diff --git a/...S/v2.1.0/qa/failed_to_start_web_server.md → ...S/v2.1.x/qa/failed_to_start_web_server.md b/...S/v2.1.0/qa/failed_to_start_web_server.md → ...S/v2.1.x/qa/failed_to_start_web_server.md
@@ -1,9 +1,9 @@
 ---
-title: hy did the web server fail to start?
+title: Why did the web server fail to start?
 lang: en-US
 ---
 
-## hy did the web server fail to start?
+## Why did the web server fail to start?
 
 The reasons for web server startup can be varied. Generally speaking, it fails because there is a problem with the local environment. web server startup failure generally consists of two parts.
 

diff --git a/docs/en-US/v2.1.x/qa/img/bee_version.png b/docs/en-US/v2.1.x/qa/img/bee_version.png
diff --git a/docs/en-US/v2.1.x/qa/img/qa/copy_request_body_false.png b/docs/en-US/v2.1.x/qa/img/qa/copy_request_body_false.png
diff --git a/docs/en-US/v2.1.x/qa/img/qa/copy_request_body_true.png b/docs/en-US/v2.1.x/qa/img/qa/copy_request_body_true.png
diff --git a/...US/v2.1.0/qa/what-is-copy-request-body.md → ...US/v2.1.x/qa/what-is-copy-request-body.md b/...US/v2.1.0/qa/what-is-copy-request-body.md → ...US/v2.1.x/qa/what-is-copy-request-body.md
@@ -3,7 +3,7 @@ title: What does CopyRequestBody mean?
 lang: en-US
 ---
 
-# CWhat does CopyRequestBody mean?
+# What does CopyRequestBody mean?
 
 In the Beego web configuration, there is a very confusing parameter called `CopyRequestBody`. It is in the structure `web.Config`.
 
@@ -39,7 +39,7 @@ func (m *MainController) ReadDataFromBody() {
 ```
 
 When we access `localhost:8080` and pass in the parameters, we can get the response:
-![CopyRequestBody=true](../../../img/qa/copy_request_body_true.png)
+![CopyRequestBody=true](./img/qa/copy_request_body_true.png)
 
 If we set `CopyRequestBody` to `false`:
 
@@ -68,7 +68,7 @@ func (m *MainController) ReadDataFromBody() {
 ```
 
 Then we will find that we cannot read the data from inside the request body:
-![CopyRequestBody=false](../../../img/qa/copy_request_body_false.png)
+![CopyRequestBody=false](./img/qa/copy_request_body_false.png)
 
 So, be aware that you should set `CopyRequestBody` to `true` if you intend to rely on Beego to process the request.
 

diff --git a/...1.0/qa/why_can_not_read_data_from_body.md → ...1.x/qa/why_can_not_read_data_from_body.md b/...1.0/qa/why_can_not_read_data_from_body.md → ...1.x/qa/why_can_not_read_data_from_body.md
diff --git a/docs/en-US/v2.1.0/task/README.md → docs/en-US/v2.1.x/task/README.md b/docs/en-US/v2.1.0/task/README.md → docs/en-US/v2.1.x/task/README.md
diff --git a/docs/en-US/v2.1.0/validation/README.md → docs/en-US/v2.1.x/validation/README.md b/docs/en-US/v2.1.0/validation/README.md → docs/en-US/v2.1.x/validation/README.md
diff --git a/docs/en-US/v2.1.0/web/README.md → docs/en-US/v2.1.x/web/README.md b/docs/en-US/v2.1.0/web/README.md → docs/en-US/v2.1.x/web/README.md
diff --git a/docs/en-US/v2.1.0/web/admin/README.md → docs/en-US/v2.1.x/web/admin/README.md b/docs/en-US/v2.1.0/web/admin/README.md → docs/en-US/v2.1.x/web/admin/README.md
diff --git a/...en-US/v2.1.0/web/admin/img/monitoring.png → ...en-US/v2.1.x/web/admin/img/monitoring.png b/...en-US/v2.1.0/web/admin/img/monitoring.png → ...en-US/v2.1.x/web/admin/img/monitoring.png
diff --git a/docs/en-US/v2.1.0/web/config.md → docs/en-US/v2.1.x/web/config.md b/docs/en-US/v2.1.0/web/config.md → docs/en-US/v2.1.x/web/config.md
diff --git a/docs/en-US/v2.1.0/web/context/README.md → docs/en-US/v2.1.x/web/context/README.md b/docs/en-US/v2.1.0/web/context/README.md → docs/en-US/v2.1.x/web/context/README.md
diff --git a/docs/en-US/v2.1.0/web/cookie/README.md → docs/en-US/v2.1.x/web/cookie/README.md b/docs/en-US/v2.1.0/web/cookie/README.md → docs/en-US/v2.1.x/web/cookie/README.md
diff --git a/docs/en-US/v2.1.0/web/error/README.md → docs/en-US/v2.1.x/web/error/README.md b/docs/en-US/v2.1.0/web/error/README.md → docs/en-US/v2.1.x/web/error/README.md
diff --git a/docs/en-US/v2.1.0/web/error/img/401.png → docs/en-US/v2.1.x/web/error/img/401.png b/docs/en-US/v2.1.0/web/error/img/401.png → docs/en-US/v2.1.x/web/error/img/401.png
diff --git a/docs/en-US/v2.1.0/web/file/README.md → docs/en-US/v2.1.x/web/file/README.md b/docs/en-US/v2.1.0/web/file/README.md → docs/en-US/v2.1.x/web/file/README.md
diff --git a/docs/en-US/v2.1.0/web/filter/README.md → docs/en-US/v2.1.x/web/filter/README.md b/docs/en-US/v2.1.0/web/filter/README.md → docs/en-US/v2.1.x/web/filter/README.md
diff --git a/docs/en-US/v2.1.0/web/grace.md → docs/en-US/v2.1.x/web/grace.md b/docs/en-US/v2.1.0/web/grace.md → docs/en-US/v2.1.x/web/grace.md
diff --git a/docs/en-US/v2.1.0/web/input/README.md → docs/en-US/v2.1.x/web/input/README.md b/docs/en-US/v2.1.0/web/input/README.md → docs/en-US/v2.1.x/web/input/README.md
diff --git a/docs/en-US/v2.1.0/web/output/README.md → docs/en-US/v2.1.x/web/output/README.md b/docs/en-US/v2.1.0/web/output/README.md → docs/en-US/v2.1.x/web/output/README.md
diff --git a/docs/en-US/v2.1.0/web/router/README.md → docs/en-US/v2.1.x/web/router/README.md b/docs/en-US/v2.1.0/web/router/README.md → docs/en-US/v2.1.x/web/router/README.md
diff --git a/.../en-US/v2.1.0/web/router/best_practice.md → .../en-US/v2.1.x/web/router/best_practice.md b/.../en-US/v2.1.0/web/router/best_practice.md → .../en-US/v2.1.x/web/router/best_practice.md
diff --git a/...US/v2.1.0/web/router/ctrl_style/README.md → ...US/v2.1.x/web/router/ctrl_style/README.md b/...US/v2.1.0/web/router/ctrl_style/README.md → ...US/v2.1.x/web/router/ctrl_style/README.md
diff --git a/...2.1.0/web/router/ctrl_style/controller.md → ...2.1.x/web/router/ctrl_style/controller.md b/...2.1.0/web/router/ctrl_style/controller.md → ...2.1.x/web/router/ctrl_style/controller.md
diff --git a/...web/router/ctrl_style/img/hello_world.png → ...web/router/ctrl_style/img/hello_world.png b/...web/router/ctrl_style/img/hello_world.png → ...web/router/ctrl_style/img/hello_world.png
diff --git a/...1.0/web/router/functional_style/README.md → ...1.x/web/router/functional_style/README.md b/...1.0/web/router/functional_style/README.md → ...1.x/web/router/functional_style/README.md
diff --git a/docs/en-US/v2.1.0/web/router/namespace.md → docs/en-US/v2.1.x/web/router/namespace.md b/docs/en-US/v2.1.0/web/router/namespace.md → docs/en-US/v2.1.x/web/router/namespace.md
diff --git a/docs/en-US/v2.1.0/web/router/router_rule.md → docs/en-US/v2.1.x/web/router/router_rule.md b/docs/en-US/v2.1.0/web/router/router_rule.md → docs/en-US/v2.1.x/web/router/router_rule.md
diff --git a/docs/en-US/v2.1.0/web/router/router_tree.md → docs/en-US/v2.1.x/web/router/router_tree.md b/docs/en-US/v2.1.0/web/router/router_tree.md → docs/en-US/v2.1.x/web/router/router_tree.md
diff --git a/docs/en-US/v2.1.0/web/session/README.md → docs/en-US/v2.1.x/web/session/README.md b/docs/en-US/v2.1.0/web/session/README.md → docs/en-US/v2.1.x/web/session/README.md
diff --git a/docs/en-US/v2.1.0/web/view/README.md → docs/en-US/v2.1.x/web/view/README.md b/docs/en-US/v2.1.0/web/view/README.md → docs/en-US/v2.1.x/web/view/README.md
diff --git a/docs/en-US/v2.1.0/web/view/func.md → docs/en-US/v2.1.x/web/view/func.md b/docs/en-US/v2.1.0/web/view/func.md → docs/en-US/v2.1.x/web/view/func.md
diff --git a/docs/en-US/v2.1.0/web/view/page.md → docs/en-US/v2.1.x/web/view/page.md b/docs/en-US/v2.1.0/web/view/page.md → docs/en-US/v2.1.x/web/view/page.md
diff --git a/docs/en-US/v2.1.0/web/view/static_file.md → docs/en-US/v2.1.x/web/view/static_file.md b/docs/en-US/v2.1.0/web/view/static_file.md → docs/en-US/v2.1.x/web/view/static_file.md
diff --git a/docs/en-US/v2.1.0/web/xsrf/README.md → docs/en-US/v2.1.x/web/xsrf/README.md b/docs/en-US/v2.1.0/web/xsrf/README.md → docs/en-US/v2.1.x/web/xsrf/README.md
diff --git a/docs/en-US/v2.2.x/README.md b/docs/en-US/v2.2.x/README.md
@@ -0,0 +1,129 @@
+---
+title: Quickly Start
+lang: en-US
+---
+
+# Quickly Start
+
+First make sure you have GO installed, version 1.16 or higher, and that you have set the GOPATH environment variable and added GOPATH/bin to the environment variable.
+
+> We recommend that you simply use the latest stable version, as we try to stay on top of the latest version of Go.
+
+Or you can refer:
+
+[Windows installation](environment/install_go_windows.md)
+
+[Linux installation](environment/install_go_linux.md)
+
+[Mac installation](environment/install_go_mac.md)
+
+**Please note that after `Beego` V2 we require the `go mod` feature, make sure that the `go mod` feature is turned on, i.e. `GO111MODULE=on`**. More details refer to [Go module](environment/go_mod.md)
+
+Or you can specify the GOPROXY:
+
+```shell
+GOPROXY=https://goproxy.cn
+```
+
+Next, let's try to start a `hello world` example. In this example, we will use the `Bee` tool to create the `hello world` project.
+
+More details refer to [Bee](./bee/README.md)
+
+## Steps
+
+If you already have a development environment installed, then you may consider using our quick install script.
+
+### Mac or Linux
+
+Run:
+
+```shell
+bash <(curl -s https://raw.githubusercontent.com/beego/beego-doc/main/scripts/quickstart.sh)
+```
+
+Or using wget:
+
+```shell
+bash <(wget -qO- https://raw.githubusercontent.com/beego/beego-doc/main/scripts/quickstart.sh)
+```
+
+### Windows
+
+Using `curl`：
+
+```shell
+bash <(curl -s https://raw.githubusercontent.com/beego/beego-doc/main/scripts/quickstart.bat)
+```
+
+Or `wget`
+
+```shell
+bash <(wget -qO- https://raw.githubusercontent.com/beego/beego-doc/main/scripts/quickstart.bat)
+```
+
+## Manual Installation
+
+In this section, we will use the `go get` command, so if you are not familiar with it, we suggest that you read [Go get](environment/go_get_command.md)
+
+Always remember, if you experience network problems, or timeout issues, make sure you set up the `GOPROXY` proxy.
+
+### Install Bee
+
+Run:
+
+```shell
+go get -u github.com/beego/bee/v2@latest
+```
+
+And then
+
+```shell
+bee version
+```
+
+you can see:
+
+```shell
+| ___ \
+| |_/ /  ___   ___
+| ___ \ / _ \ / _ \
+| |_/ /|  __/|  __/
+\____/  \___| \___| v2.0.x
+
+├── Beego     : Beego is not installed. Please do consider installing it first: https://github.com/beego/beego/v2. If you are using go mod, and you don't install the beego under $GOPATH/src/github.com/beego, just ignore this.
+├── GoVersion : go1.16
+├── GOOS      : linux
+├── GOARCH    : amd64
+├── NumCPU    : 12
+├── GOPATH    : /home/xxx/go
+├── GOROOT    : /home/aaa/bbb/go
+├── Compiler  : gc
+└── Published : 2020-12-16
+
+```
+
+### Create Project
+
+Run:
+
+```shell
+bee new hello
+cd hello
+go mod tidy
+```
+
+And then:
+
+```shell
+bee run
+```
+you can see:
+
+```shell
+2021/03/31 23:29:19 SUCCESS  ▶ 0004 Built Successfully!
+2021/03/31 23:29:19 INFO     ▶ 0005 Restarting 'hello'...
+2021/03/31 23:29:19 SUCCESS  ▶ 0006 './hello' is running...
+2021/03/31 23:29:22.016 [I] [parser.go:413]  generate router from comments
+
+2021/03/31 23:29:22.016 [I] [server.go:241]  http server Running on http://:8080
+```