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

13
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
@ -86,7 +87,6 @@ $ 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.
@ -96,7 +96,6 @@ $ 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**
@ -118,7 +117,6 @@ $ 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
@ -173,7 +171,7 @@ For more examples check [Realize Examples](https://github.com/tockins/realize-ex
file_err: false file_err: false
``` ```
- This is the configuration used for develop realize This is the configuration used for develop realize
``` ```
settings: settings:
@ -219,7 +217,6 @@ For more examples check [Realize Examples](https://github.com/tockins/realize-ex
###### 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)