Skip to content

Commit 60ad28e

Browse files
authored
docs: update docs (#6)
* docs: update docs * remove relative current * update prc
1 parent 54f98d0 commit 60ad28e

26 files changed

+542
-1016
lines changed

.github/workflows/prc.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ permissions:
99
jobs:
1010
build:
1111
name: build
12-
runs-on: self-hosted
12+
runs-on: ubuntu-latest
1313
steps:
1414
- uses: actions/checkout@v3
1515
# with:
@@ -53,7 +53,7 @@ jobs:
5353
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
5454
golangci:
5555
name: lint
56-
runs-on: self-hosted
56+
runs-on: ubuntu-latest
5757
steps:
5858
- uses: actions/setup-go@v4
5959
with:
@@ -67,7 +67,7 @@ jobs:
6767
skip-cache: true
6868
typos:
6969
name: typos
70-
runs-on: self-hosted
70+
runs-on: ubuntu-latest
7171
steps:
7272
- uses: actions/checkout@v3
7373
- name: typos

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ $ go install go.uber.org/mock/mockgen@latest
9090

9191
### Generation of Full Project
9292

93-
* Copy and paste the following to `helloworld.proto`, you can get it from [./docs/helloworld/helloworld.proto](./docs/helloworld/helloworld.proto):
93+
* Copy and paste the following to `helloworld.proto`, you can get it from [docs/helloworld/helloworld.proto](docs/helloworld/helloworld.proto):
9494

9595
```protobuf
9696
syntax = "proto3";
@@ -195,7 +195,7 @@ For additional flags please run `trpc -h` and `trpc [subcmd] -h`.
195195

196196
### Functionalities
197197

198-
Please check [Documentation](./docs/)
198+
Please check [Documentation](docs/README.md)
199199

200200
## Contributing
201201

README.zh_CN.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ $ go install go.uber.org/mock/mockgen@latest
9090

9191
### 生成完整项目
9292

93-
* 将以下内容复制到 `helloworld.proto`, 原始文件为 [./docs/helloworld/helloworld.proto](./docs/helloworld/helloworld.proto):
93+
* 将以下内容复制到 `helloworld.proto`, 原始文件为 [docs/helloworld/helloworld.proto](docs/helloworld/helloworld.proto):
9494

9595
```protobuf
9696
syntax = "proto3";
@@ -195,7 +195,7 @@ out
195195

196196
### 更多功能
197197

198-
请查看 [文档](./docs/)
198+
请查看 [文档](docs/README.zh_CN.md)
199199

200200
## 贡献
201201

cmd/create/cmdflags.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func AddCreateFlags(createCmd *cobra.Command) {
3232
// Select code template.
3333
createCmd.Flags().String("assetdir", "", "Specify the custom template path, e.g., ~/.trpc-cmdline-assets/protobuf/asset_go")
3434
createCmd.Flags().StringP("lang", "l", "go",
35-
"Specify the programming language to use, supported languages: go")
35+
"Specify the programming language to use, supported languages: go, cpp")
3636
createCmd.Flags().Bool("rpconly", false,
3737
"Only generate stub code (recommended to execute under the stub directory), can be used with -o")
3838
createCmd.Flags().Bool("dependencystub", false,

docs/1-设计实现.md

-12
This file was deleted.

docs/2-代码模板.md

-47
This file was deleted.

docs/3-使用示例.md

-43
This file was deleted.

docs/4-flatbuffers.md

-211
This file was deleted.

0 commit comments

Comments
 (0)