a/realize
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc improved for the run command

Browse Source
This commit is contained in:
alessio 2016-11-20 18:44:42 +01:00
parent aed3510605
commit bb918cfb33
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -50,9 +50,9 @@ A Go build system with file watchers, output streams and live reload. Run, build
$ realize add
```
It will create a realize.config.yaml file if it doesn't exist already and adds the working directory as the project.
It will create a realize.yaml file if it doesn't exist already and adds the working directory as the project.
Otherwise if a config file already exists it adds another project to the existing config file.
Otherwise if a config file already exists it adds the working project to the existing config file.
The add command supports the following custom parameters:
@ -109,7 +109,8 @@ A Go build system with file watchers, output streams and live reload. Run, build
$ realize run
```
Run can also launch a project from its working directory without a config file. It supports the following custom parameters:
Run can also launch a project from its working directory with or without make a config file (--no-config option).
It supports the following custom parameters:
```
--path="server" -> Custom Path, if not specified takes the working directory name
@ -120,9 +121,10 @@ A Go build system with file watchers, output streams and live reload. Run, build
--no-run -> Disables the run
--no-fmt -> Disables the fmt (go fmt)
--no-server -> Disables the web panel (port :5000)
--no-config -> Doesn't create any configuration files
--open -> Open the web panel in a new browser window
```
And addittional arguments as the "add" command.
And additional arguments as the "add" command.
```
$ realize run --no-run yourParams --yourFlags // correct