doc layout
This commit is contained in:
parent
1e28dd6cca
commit
864a91c03d
16
README.md
16
README.md
|
@ -44,7 +44,7 @@ $ go get github.com/tockins/realize
|
||||||
```
|
```
|
||||||
#### Commands
|
#### Commands
|
||||||
|
|
||||||
##### Run
|
- ##### Run
|
||||||
From project/projects root execute:
|
From project/projects root execute:
|
||||||
```
|
```
|
||||||
$ realize run
|
$ realize run
|
||||||
|
@ -85,7 +85,7 @@ If you want, you can specify additional arguments for your project.
|
||||||
$ 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.
|
||||||
|
|
||||||
|
@ -95,7 +95,7 @@ Add a project to an existing config file or create a new one without run the pip
|
||||||
$ 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.
|
||||||
|
|
||||||
|
@ -105,19 +105,19 @@ Like add, but with this command you can create a configuration step by step and
|
||||||
$ 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
|
||||||
|
@ -125,9 +125,9 @@ $ realize list
|
||||||
- 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:
|
||||||
|
|
Loading…
Reference in New Issue