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

doc updated

Browse Source
This commit is contained in:
alessio 2016-11-14 09:28:34 +01:00
parent 5b42067a02
commit 2d462a603c
1 changed files with 44 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
README.md
View File

@ -109,13 +109,7 @@ A Go build system with file watchers, output streams and live reload. Run, build
$ realize run $ realize run
``` ```
Fast run launches a project from its working directory without a config file Run can also launch a project from its working directory without a config file. It supports the following custom parameters:
```
$ realize fast
```
The fast command supports the following custom parameters:
``` ```
--path="server" -> Custom Path, if not specified takes the working directory name --path="server" -> Custom Path, if not specified takes the working directory name
@ -128,17 +122,16 @@ A Go build system with file watchers, output streams and live reload. Run, build
--no-server -> Disables the web panel (port :5000) --no-server -> Disables the web panel (port :5000)
--open -> Open the web panel in a new browser window --open -> Open the web panel in a new browser window
``` ```
The "fast" command supports addittional arguments as the "add" command. And addittional arguments as the "add" command.
``` ```
$ realize fast --no-run yourParams --yourFlags // correct $ realize run --no-run yourParams --yourFlags // correct
$ realize fast yourParams --yourFlags --no-run // wrong $ realize run yourParams --yourFlags --no-run // wrong
$ realize fast --path="/Users/alessio/go/src/github.com/tockins/realize-examples/coin/" $ realize run --path="/Users/alessio/go/src/github.com/tockins/realize-examples/coin/"
``` ```
#### Color reference #### Color reference
- Blue: outputs of the project - Blue: outputs of the project
@ -152,38 +145,46 @@ A Go build system with file watchers, output streams and live reload. Run, build
- For more examples check [Realize Examples](https://github.com/tockins/realize-examples) - For more examples check [Realize Examples](https://github.com/tockins/realize-examples)
``` ```
projects: settings:
- app_name: App One -> name resources:
app_path: one -> root path output: outputs.log // name of the output file
app_run: true -> enable/disable go run (require app_bin) log: logs.log // name of the log file (errors included)
app_bin: true -> enable/disable go install server:
app_build: false -> enable/disable go build enable: true // enables the web server
app_fmt: true -> enable/disable go fmt open: false // opens the web server in a new tab
app_test: true -> enable/disable go test host: localhost // web server host
app_params: -> the project will be launched with these parameters port: 5000 // wev server port
- --flag1 projects:
- param1 - name: printer // project name
app_watcher: path: / // project path
preview: true -> prints the observed files on startup run: true // enables go run (require bin)
paths: -> paths to observe for live reload bin: true // enables go install
- / generate: false // enables go generate
ignore_paths: -> paths to ignore build: false // enables go build
- vendor fmt: true // enables go fmt
- bin test: false // enables go test
exts: -> file extensions to observe for live reload params: [] // array of additionals params. the project will be launched with these parameters
- .go watcher:
output: -> enable/disable the output destinations before: [] // custom commands launched before the execution of the project
cli: true -> cli output after: [] // custom commands launched after the execution of the project
file: true -> creates an output file inside the project paths: // paths to observe for live reload
- /
ignore_paths: // paths to ignore
- vendor
exts: // file extensions to observe for live reload
- .go
preview: true // prints the observed files on startup
cli:
streams: true // prints the output streams of the project in the cli
file:
streams: false // saves the output stream of the project in a file
logs: false // saves the logs of the project in a file
errors: false // saves the errors of the project in a file
``` ```
#### Next release #### Next release
##### v1.2 ##### v1.3
- [ ] Windows support
- [ ] Go generate support
- [ ] Web panel - watched file
- [ ] Web panel - edit settings - [ ] Web panel - edit settings
#### Contacts #### Contacts