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

doc layout

This commit is contained in:
alessio 2017-04-01 20:42:33 +02:00
parent 864a91c03d
commit dfda110f56
1 changed files with 160 additions and 163 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

291
README.md
View File

@ -35,9 +35,10 @@ A Go build system with file watchers, output streams and live reload. Run, build
- [Remove cmd](#remove) - Remove a project - [Remove cmd](#remove) - Remove a project
- [List cmd](#list) - List the projects - [List cmd](#list) - List the projects
- [Config sample](#config-sample) - [Config sample](#config-sample)
- [Support](#support)
##### Installation - ##### Installation
Run this to get/install: Run this to get/install:
``` ```
$ go get github.com/tockins/realize $ go get github.com/tockins/realize
@ -45,181 +46,177 @@ $ go get github.com/tockins/realize
#### Commands #### Commands
- ##### Run - ##### Run
From project/projects root execute: From project/projects root execute:
``` ```
$ realize run $ realize run
``` ```
It will create a realize.yaml file if it doesn't exist already, adds the working directory as project and run the pipeline. It will create a realize.yaml file if it doesn't exist already, adds the working directory as project and run the pipeline.
The Run command supports the following custom parameters: The Run command supports the following custom parameters:
``` ```
--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
--no-install -> Disable go install --no-install -> Disable go install
--no-config -> Ignore an existing config / skip the creation of a new one --no-config -> Ignore an existing config / skip the creation of a new one
--server -> Enable the web server --server -> Enable the web server
--legacy -> Enable legacy watch instead of Fsnotify watch --legacy -> Enable legacy watch instead of Fsnotify watch
--generate -> Enable go generate --generate -> Enable go generate
--test -> Enable go test --test -> Enable go test
``` ```
Examples: Examples:
``` ```
$ realize run $ realize run
$ realize run --path="mypath" $ realize run --path="mypath"
$ realize run --name="My Project" --build $ realize run --name="My Project" --build
$ realize run --path="realize" --no-run --no-config $ realize run --path="realize" --no-run --no-config
$ realize run --path="/Users/alessio/go/src/github.com/tockins/realize-examples/coin/" $ realize run --path="/Users/alessio/go/src/github.com/tockins/realize-examples/coin/"
``` ```
If you want, you can specify additional arguments for your project. If you want, you can specify additional arguments for your project.
**The additional arguments must go after the params** **The additional arguments must go after the params**
**Run can run a project from its working directory without make a config file (--no-config).** **Run can run a project from its working directory without make a config file (--no-config).**
``` ```
$ realize run --path="/print/printer" --no-run yourParams --yourFlags // right $ realize run --path="/print/printer" --no-run yourParams --yourFlags // right
$ realize run yourParams --yourFlags --path="/print/printer" --no-run // wrong $ realize run yourParams --yourFlags --path="/print/printer" --no-run // wrong
``` ```
- ##### Add - ##### Add
Add a project to an existing config file or create a new one without run the pipeline.
Add a project to an existing config file or create a new one without run the pipeline. "Add" supports the same parameters of the "Run" command.
"Add" supports the same parameters of the "Run" command. ```
$ realize add
``` ```
$ realize add
```
- ##### Init - ##### Init
Like add, but with this command you can create a configuration step by step and customize each option.
Like add, but with this command you can create a configuration step by step and customize each option. **Init is the only command that supports a complete customization of all the options supported**
**Init is the only command that supports a complete customization of all the options supported** ```
$ realize init
``` ```
$ realize init
```
- ##### Remove - ##### Remove
Remove a project by its name Remove a project by its name
``` ```
$ realize remove --name="myname" $ realize remove --name="myname"
``` ```
- ##### List - ##### List
Projects list in cli Projects list in cli
``` ```
$ realize list $ realize list
``` ```
- #### Color reference - #### Color reference
- Blue: outputs of the project
- Blue: outputs of the project - Red: errors
- Red: errors - Magenta: times or changed files
- Magenta: times or changed files - Green: successfully completed action
- Green: successfully completed action
- #### Config sample - #### Config sample
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: settings:
legacy: legacy:
status: true // legacy watch status status: true // legacy watch status
interval: 10s // polling interval interval: 10s // polling interval
resources: // files names related to streams 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: true // server status status: true // server status
open: false // auto open in browser on start open: false // auto open in browser on start
host: localhost // server host host: localhost // server host
port: 5001 // server port port: 5001 // server port
projects: projects:
- name: realize - name: realize
path: . // project path path: . // project path
fmt: true fmt: true
generate: false generate: false
test: false test: false
bin: true bin: true
build: false build: false
run: false run: false
params: // additional params params: // additional params
- --myarg - --myarg
watcher: watcher:
preview: false // wached files preview preview: false // wached files preview
paths: // paths to watch paths: // paths to watch
- / - /
ignore_paths: // paths to ignore ignore_paths: // paths to ignore
- vendor - vendor
exts: // exts to watch exts: // exts to watch
- .go - .go
scripts: // custom commands after/before scripts: // custom commands after/before
- type: after // type after/before - type: after // type after/before
command: go run mycmd after // command command: go run mycmd after // command
path: "" // run from a custom path or from the working dir path: "" // run from a custom path or from the working dir
streams: // enable/disable 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
``` ```
- This is the configuration used for develop realize This is the configuration used for develop realize
``` ```
settings: settings:
resources: resources:
outputs: outputs.log outputs: outputs.log
logs: logs.log logs: logs.log
errors: errors.log errors: errors.log
server: server:
status: false status: false
open: false open: false
host: localhost host: localhost
port: 5001 port: 5001
projects: projects:
- name: realize - name: realize
path: /Users/alessio/go/src/github.com/tockins/realize path: /Users/alessio/go/src/github.com/tockins/realize
fmt: true fmt: true
generate: false generate: false
test: false test: false
bin: true bin: true
build: false build: false
run: false run: false
watcher: watcher:
preview: false preview: false
paths: paths:
- / - /
ignore_paths: ignore_paths:
- server/assets - server/assets
exts: exts:
- .go - .go
scripts: scripts:
- type: before - type: before
command: go-bindata -pkg="server" assets/... command: go-bindata -pkg="server" assets/...
path: server path: server
- type: after - type: after
command: go-bindata -pkg="server" assets/... command: go-bindata -pkg="server" assets/...
path: server path: server
streams: 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
``` ```
###### Support us and suggest an improvement ###### Support us and suggest an improvement
- Start the project
- Chat with us [Gitter](https://gitter.im/tockins/realize) - Chat with us [Gitter](https://gitter.im/tockins/realize)
- [Alessio Pracchia](https://www.linkedin.com/in/alessio-pracchia-38a70673) - Suggest a new [Feature](https://github.com/tockins/realize/issues/new)
- [Daniele Conventi](https://www.linkedin.com/in/conventi)