zeromicro/go-zero
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: update readme (#3011)

Browse Source
This commit is contained in:
Kevin Wan
2023-03-10 22:18:48 +08:00
committed by GitHub
parent fbf129d535
commit 123c61ad12
2 changed files with 14 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
readme-cn.md
View File

@@ -23,7 +23,7 @@
> >
> `GOPROXY=https://goproxy.cn/,direct go install github.com/zeromicro/go-zero/tools/goctl@latest` > `GOPROXY=https://goproxy.cn/,direct go install github.com/zeromicro/go-zero/tools/goctl@latest`
> >
> `goctl migrate —verbose —version v1.4.3` > `goctl migrate —verbose —version v1.5.0`
## 0. go-zero 介绍 ## 0. go-zero 介绍
@@ -119,28 +119,25 @@ GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/zeromicro
`goctl` 读作 `go control`，不要读成 `go C-T-L`。`goctl` 的意思是不要被代码控制，而是要去控制它。其中的 `go` 不是指 `golang`。在设计 `goctl` 之初，我就希望通过 `工具` 来解放我们的双手👈 `goctl` 读作 `go control`，不要读成 `go C-T-L`。`goctl` 的意思是不要被代码控制，而是要去控制它。其中的 `go` 不是指 `golang`。在设计 `goctl` 之初，我就希望通过 `工具` 来解放我们的双手👈
```shell ```shell
# Go 1.15 及之前版本 # Go
GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/zeromicro/go-zero/tools/goctl@latest
# Go 1.16 及以后版本
GOPROXY=https://goproxy.cn/,direct go install github.com/zeromicro/go-zero/tools/goctl@latest GOPROXY=https://goproxy.cn/,direct go install github.com/zeromicro/go-zero/tools/goctl@latest
# For Mac # For Mac
brew install goctl brew install goctl
# docker for amd64 architecture # docker for amd64 architecture
docker pull kevinwan/goctl docker pull kevinwan/goctl
# run goctl like # run goctl like
docker run --rm -it -v `pwd`:/app kevinwan/goctl goctl --help docker run --rm -it -v `pwd`:/app kevinwan/goctl goctl --help
# docker for arm64 (M1) architecture # docker for arm64 (M1) architecture
docker pull kevinwan/goctl:latest-arm64 docker pull kevinwan/goctl:latest-arm64
# run goctl like # run goctl like
docker run --rm -it -v `pwd`:/app kevinwan/goctl:latest-arm64 goctl --help docker run --rm -it -v `pwd`:/app kevinwan/goctl:latest-arm64 goctl --help
``` ```
确保 goctl 可执行 确保 goctl 可执行
2. 快速生成 api 服务 2. 快速生成 api 服务
```shell ```shell

17
readme.md
View File

@@ -111,7 +111,7 @@ go install github.com/zeromicro/go-zero/tools/goctl@latest
``` ```
```shell ```shell
goctl migrate —verbose —version v1.4.3 goctl migrate —verbose —version v1.5.0
``` ```
## Quick Start ## Quick Start
@@ -127,28 +127,25 @@ goctl migrate —verbose —version v1.4.3
`goctl`can be read as `go control`. `goctl` means not to be controlled by code, instead, we control it. The inside `go` is not `golang`. At the very beginning, I was expecting it to help us improve productivity, and make our lives easier. `goctl`can be read as `go control`. `goctl` means not to be controlled by code, instead, we control it. The inside `go` is not `golang`. At the very beginning, I was expecting it to help us improve productivity, and make our lives easier.
```shell ```shell
# for Go 1.15 and earlier # for Go
GO111MODULE=on go get -u github.com/zeromicro/go-zero/tools/goctl@latest
# for Go 1.16 and later
go install github.com/zeromicro/go-zero/tools/goctl@latest go install github.com/zeromicro/go-zero/tools/goctl@latest
# For Mac # For Mac
brew install goctl brew install goctl
# docker for amd64 architecture # docker for amd64 architecture
docker pull kevinwan/goctl docker pull kevinwan/goctl
# run goctl like # run goctl like
docker run --rm -it -v `pwd`:/app kevinwan/goctl goctl --help docker run --rm -it -v `pwd`:/app kevinwan/goctl goctl --help
# docker for arm64 (M1) architecture # docker for arm64 (M1) architecture
docker pull kevinwan/goctl:latest-arm64 docker pull kevinwan/goctl:latest-arm64
# run goctl like # run goctl like
docker run --rm -it -v `pwd`:/app kevinwan/goctl:latest-arm64 goctl --help docker run --rm -it -v `pwd`:/app kevinwan/goctl:latest-arm64 goctl --help
``` ```
make sure goctl is executable. make sure goctl is executable.
3. create the API file, like greet.api, you can install the plugin of goctl in vs code, api syntax is supported. 3. create the API file, like greet.api, you can install the plugin of goctl in vs code, api syntax is supported.
```go ```go