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

Merge pull request #64 from tockins/dev

Browse Source 
Doc updated
This commit is contained in:
Alessio Pracchia 2017-06-19 13:30:30 +02:00 committed by GitHub
commit 7d4f74ddea
1 changed files with 40 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
README.md
View File

@ -65,6 +65,7 @@ $ go get github.com/tockins/realize
The Run command supports the following custom parameters: The Run command supports the following custom parameters:
``` ```
--name="name" -> Run by name on existing configuration
--path="realize/server" -> Custom Path, if not specified takes the working directory name --path="realize/server" -> Custom Path, if not specified takes the working directory name
--build -> Enable go build --build -> Enable go build
--no-run -> Disable go run --no-run -> Disable go run
@ -136,92 +137,57 @@ $ go get github.com/tockins/realize
For more examples check [Realize Examples](https://github.com/tockins/realize-examples) For more examples check [Realize Examples](https://github.com/tockins/realize-examples)
```
settings:
legacy:
status: true // legacy watch status
interval: 10s // polling interval
resources: // files names related to streams
outputs: outputs.log
logs: logs.log
errors: errors.log
server:
status: true // server status
open: false // auto open in browser on start
host: localhost // server host
port: 5001 // server port
projects:
- name: realize
path: . // project path
fmt: true
generate: false
test: false
bin: true
build: false
run: false
params: // additional params
- --myarg
watcher:
preview: false // wached files preview
paths: // paths to watch
- /
ignore_paths: // paths to ignore
- vendor
exts: // exts to watch
- .go
scripts: // custom commands after/before
- type: after // type after/before
command: go run mycmd after // command
path: "" // run from a custom path or from the working dir
streams: // enable/disable streams
cli_out: true
file_out: false
file_log: false
file_err: false
```
This is the configuration used for develop realize
``` ```
settings: settings:
resources: legacy:
status: true // legacy watch status
interval: 10s // polling interval
resources: // files names related to streams
outputs: outputs.log outputs: outputs.log
logs: logs.log logs: logs.log
errors: errors.log errors: errors.log
server: server:
status: false status: false // server status
open: false open: false // open browser at start
host: localhost host: localhost // server host
port: 5001 port: 5001 // server port
projects: projects:
- name: realize - name: coin
path: /Users/alessio/go/src/github.com/tockins/realize path: coin // project path
fmt: true commands:
generate: false vet: true
test: false fmt: true
bin: true test: false
build: false generate: false
run: false bin:
status: true
build:
status: false
run: true
args:
- --myarg
watcher: watcher:
preview: false preview: false // watched files preview
paths: paths: // watched paths
- / - /
ignore_paths: ignore_paths: // ignored paths
- server/assets - vendor
exts: exts: // watched extensions
- .go - .go
scripts: scripts:
- type: before - type: before // type
command: go-bindata -pkg="server" assets/... command: ./ls -l // command
path: server changed: true // relaunch when a file changes
startuo: true // launch at start
- type: after - type: after
command: go-bindata -pkg="server" assets/... command: ./ls
path: server changed: true
streams: streams: // enable/disable streams
cli_out: true cli_out: true
file_out: false file_out: false
file_log: false file_log: false
file_err: false file_err: false
``` ```