diff --git a/docs/README.rst b/docs/README.rst index 5073e0b..5d3bcc3 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -31,6 +31,8 @@ If you are interested in writing or contributing to formulas, please pay attenti If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``, which contains the currently released version. This formula is versioned according to `Semantic Versioning `_. +If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section. + See `Formula Versioning Section `_ for more details. Contributing to this repo @@ -40,6 +42,11 @@ Contributing to this repo Please see `How to contribute `_ for more details. +Special notes +------------- + +This formula uses (non-default) GOPATH environment variable on Unix by default; see ``go_path`` key in ``defaults.yaml`` and ``pillar.example`` files. Normally GOPATH defaults to ``$HOME/go`` on Unix/Darwin, ``$home/go`` on Plan9, and ``%USERPROFILE%\go`` on Windows; another common setup is ``GOPATH=$HOME && export PATH=$PATH:$(go env GOPATH)/bin`` too. + Available states ----------------