Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yanue committed Jun 17, 2021
1 parent dd4ee2c commit 912b87a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Gowatch will watch for file events, and every time you create/modify/delete a fi
- -p : Not required, specify the package to be built (can also be a single file)
- -args: Not required, specify program runtime parameters, for example: -args = '-host =: 8080, -name = demo'
- -v: Not required, display gowatch version information
- -h: Not required, show usage

example:

Expand All @@ -51,8 +52,12 @@ example:
### Configuration file

In most cases, you don't need to specify the configuration. You can meet most of the requirements by directly executing the `gowatch` command.
Create a `gowatch.yml` file in the execution directory:

You can initialize the gowatch.yml configuration file to the current directory with the default settings running the following command.
```
gowatch init
```
Create a `gowatch.yml` file in the execution directory:
```
# gowatch.yml configuration example
Expand Down
8 changes: 7 additions & 1 deletion README_ZH_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ go get github.com/silenceper/gowatch
- -p : 非必须,指定需要build的package(也可以是单个文件)
- -args: 非必须,指定程序运行时参数,例如:-args='-host=:8080,-name=demo'
- -v: 非必须,显示gowatch版本信息
- -h: 非必须,帮助信息

例子:

Expand All @@ -33,8 +34,13 @@ go get github.com/silenceper/gowatch
### 配置文件
`gowatch.yml`

大部分情况下,不需要更改配置,直接执行`gowatch`命令就能满足的大部分的需要,但是也提供了一些配置用于自定义,在执行目录下创建`gowatch.yml`文件:
大部分情况下,不需要更改配置,直接执行`gowatch`命令就能满足的大部分的需要,但是也提供了一些配置用于自定义

可以通过以下命令生成默认配置
```
gowatch init
```
会在执行目录下创建`gowatch.yml`文件
```
# gowatch.yml 配置示例
Expand Down

0 comments on commit 912b87a

Please sign in to comment.