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

119
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
- [List cmd](#list) - List the projects
- [Config sample](#config-sample)
- [Support](#support)
##### Installation
- ##### Installation
Run this to get/install:
```
$ go get github.com/tockins/realize
@ -45,89 +46,86 @@ $ go get github.com/tockins/realize
#### Commands
- ##### Run
From project/projects root execute:
```
$ realize run
```
From project/projects root execute:
```
$ 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
--build -> Enable go build
--no-run -> Disable go run
--no-install -> Disable go install
--no-config -> Ignore an existing config / skip the creation of a new one
--server -> Enable the web server
--legacy -> Enable legacy watch instead of Fsnotify watch
--generate -> Enable go generate
--test -> Enable go test
```
Examples:
```
--path="realize/server" -> Custom Path, if not specified takes the working directory name
--build -> Enable go build
--no-run -> Disable go run
--no-install -> Disable go install
--no-config -> Ignore an existing config / skip the creation of a new one
--server -> Enable the web server
--legacy -> Enable legacy watch instead of Fsnotify watch
--generate -> Enable go generate
--test -> Enable go test
```
Examples:
```
$ realize run
$ realize run --path="mypath"
$ realize run --name="My Project" --build
$ realize run --path="realize" --no-run --no-config
$ realize run --path="/Users/alessio/go/src/github.com/tockins/realize-examples/coin/"
```
```
$ realize run
$ realize run --path="mypath"
$ realize run --name="My Project" --build
$ realize run --path="realize" --no-run --no-config
$ 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**
**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 yourParams --yourFlags --path="/print/printer" --no-run // wrong
```
```
$ realize run --path="/print/printer" --no-run yourParams --yourFlags // right
$ realize run yourParams --yourFlags --path="/print/printer" --no-run // wrong
```
- ##### 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
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 a project by its name
```
$ realize remove --name="myname"
```
Remove a project by its name
```
$ realize remove --name="myname"
```
- ##### List
Projects list in cli
```
$ realize list
```
Projects list in cli
```
$ realize list
```
- #### Color reference
- Blue: outputs of the project
- Red: errors
- Magenta: times or changed files
- Green: successfully completed action
- Blue: outputs of the project
- Red: errors
- Magenta: times or changed files
- Green: successfully completed action
- #### 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:
@ -173,7 +171,7 @@ For more examples check [Realize Examples](https://github.com/tockins/realize-ex
file_err: false
```
- This is the configuration used for develop realize
This is the configuration used for develop realize
```
settings:
@ -219,7 +217,6 @@ For more examples check [Realize Examples](https://github.com/tockins/realize-ex
###### Support us and suggest an improvement
- Start the project
- Chat with us [Gitter](https://gitter.im/tockins/realize)
- [Alessio Pracchia](https://www.linkedin.com/in/alessio-pracchia-38a70673)
- [Daniele Conventi](https://www.linkedin.com/in/conventi)
- Suggest a new [Feature](https://github.com/tockins/realize/issues/new)