Skip to content

Commit

Permalink
fix Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kozmod committed Jan 19, 2023
1 parent 05a299f commit 6dc66c8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
28 changes: 14 additions & 14 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kozmod/progen)

Simple projects generator.

___
### Installation

```console
Expand All @@ -17,21 +17,21 @@ go install github.com/kozmod/progen@latest
```console
go build -o progen .
```

___
### About

`progen` use `yml` config file to generate directories, files and execute commands

#### Allowed config file's keys
`progen` use `yml` config file to generate directories, files and execute commands ([actions](#Actions))
___
### Args

| Name | Type | Description |
|:-----|:------:|:------------------------------------------------------------------:|
| f | string | path to config file |
| v | bool | verbose output |
| dr | bool | `dry run` mode <br/>(to verbose output should be combine with`-v`) |
| help | bool | show flags |

#### Action config file's tags
___
### Actions

| Key | Type | Optional | Description |
|:------------------|:-----------------:|:--------:|:---------------------------------------------------------------------------------:|
Expand All @@ -58,8 +58,8 @@ go build -o progen .
✳️ required one of for parent block

**❗Note:** all action execute on declaration order

#### Example
___
### Example

```yaml
## preprocessing of "raw" config use `text/template` of golang's stdlib
Expand Down Expand Up @@ -136,22 +136,22 @@ files:
cmd:
- curl -H PRIVATE-TOKEN:{{.vars.TOKEN}} {{.vars.REPO_1}}/.editorconfig/raw?ref=master -o .editorconfig
```
___
### Generate
#### Generate project structure from configuration file
use configuration file with default name (`progen.yaml`)
`progen` use `progen.yaml` as default configuration file

```console
progen -v
```

or define custom config location using `-f`
`-f` flag set custom configuration file

```console
progen -v -f conf.yml
```

generated project structure
generated files and directories

```console
.
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ var (
flagConfigPath = flag.String(
"f",
entity.Empty,
fmt.Sprintf("configuration file path (if not set, default configuration is used: %s)", defaultConfigFilePath))
fmt.Sprintf("configuration file path (default file: %s)", defaultConfigFilePath))
flagVerbose = flag.Bool(
"v",
false,
Expand Down

0 comments on commit 6dc66c8

Please sign in to comment.