diff options
| author | Dave Henderson <dhenderson@gmail.com> | 2016-09-06 23:08:45 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-06 23:08:45 -0400 |
| commit | 1ea24b5d252d586181b3e5a4234451b9b138ea5e (patch) | |
| tree | 1ebd156ea5ff1c538b7983e6a97938aec19a2349 | |
| parent | 750bcb1c9013652c2935fbfbbeefa659d16172af (diff) | |
| parent | a06fa7566684a76cc3b4c040a474a64b28b25c9d (diff) | |
Merge pull request #64 from hairyhenderson/better-install-contrib-docs
Improving docs and adding contrib instructions
| -rw-r--r-- | CONTRIBUTING.md | 8 | ||||
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | README.md | 19 |
3 files changed, 30 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..3e2ab3b2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contributing to gomplate + +Thanks for considering a contribution! All contributions are welcome, including +bug reports, bug fixes, new features or even just questions. + +For PRs, please: +- add new tests to cover the new code +- make sure all of the tests pass (`make test`) @@ -43,6 +43,9 @@ $(PREFIX)/bin/$(PKG_NAME)$(call extension,$(GOOS)): $(shell find . -type f -name build: $(PREFIX)/bin/$(PKG_NAME)$(call extension,$(GOOS)) +test: + $(GO) test -v -race $(PREFIX)/... + gen-changelog: github_changelog_generator --no-filter-by-milestone --exclude-labels duplicate,question,invalid,wontfix,admin @@ -12,6 +12,25 @@ I really like `envsubst` for use as a super-minimalist template processor. But i Gomplate is an alternative that will let you process templates which also include shell-like variables. Also there are some useful built-in functions that can be used to make templates even more expressive. +## Installing + +1. Get the latest `gomplate` for your platform from the [releases](https://github.com/hairyhenderson/gomplate/releases) page +2. Store the downloaded binary somewhere in your path as `gomplate` (or `gomplate.exe` + on Windows) +3. Make sure it's executable (on Linux/macOS) +3. Test it out with `gomplate --help`! + +In other words: + +```console +$ curl -o /usr/local/bin/gomplate https://github.com/hairyhenderson/gomplate/releases/download/<version>/gomplate_<os>-<arch> +$ chmod 755 /usr/local/bin/gomplate +$ gomplate --help +... +``` + +_Please report any bugs found in the [issue tracker](https://github.com/hairyhenderson/gomplate/issues/)._ + ## Usage The usual and most basic usage of `gomplate` is to just replace environment variables. All environment variables are available by referencing `.Env` (or `getenv`) in the template. |