unistack-org/protoc-gen-gotemplate
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Manfred Touron 2017-03-16 16:15:10 +01:00 committed by GitHub
parent 6d0ee10322
commit 191df6c8ec
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -5,7 +5,7 @@ A generic **code**/script/data generator based on [Protobuf](https://developers.
--- ---
This is a generator plugin for the Google Protocol Buffers compiler (`protoc`). This project is a generator plugin for the Google Protocol Buffers compiler (`protoc`).
The plugin parses **protobuf** files, generates an **ast**, and walks a local **templates directory** to generate files using the [Golang's `text/template` engine](https://golang.org/pkg/text/template/). The plugin parses **protobuf** files, generates an **ast**, and walks a local **templates directory** to generate files using the [Golang's `text/template` engine](https://golang.org/pkg/text/template/).
@ -26,7 +26,7 @@ The plugin parses **protobuf** files, generates an **ast**, and walks a local **
`protoc-gen-gotemplate` requires a **template_dir** directory *(by default `./templates`)*. `protoc-gen-gotemplate` requires a **template_dir** directory *(by default `./templates`)*.
Every files ending with `.tmpl` will be processed and written in the destination folder, following the file hierarchy of the `template_dir`, and removing the `.tmpl` extension. Every file ending with `.tmpl` will be processed and written to the destination folder, following the file hierarchy of the `template_dir`, and remove the `.tmpl` extension.
--- ---
@ -49,6 +49,12 @@ $> protoc --gotemplate_out=debug=true,template_dir=/path/to/template/directory:.
--- ---
##### Hints
Shipping the templates with your project is very smart and useful when contributing on git-based projects.
Another workflow consists in having a dedicated repository for generic templates which is then versioned and vendored with multiple projects (npm package, golang vendor package, ...)
See [examples](./examples). See [examples](./examples).
## Funcmap ## Funcmap
@ -65,10 +71,6 @@ Non-exhaustive list of new helpers:
See the project helpers for the complete list. See the project helpers for the complete list.
## Hacks
## Install ## Install
* Install the **Go** compiler and tools from https://golang.org/doc/install * Install the **Go** compiler and tools from https://golang.org/doc/install