Skip to content

Commit

Permalink
docs(readme): clarify gopath and goroot
Browse files Browse the repository at this point in the history
  • Loading branch information
noelmcloughlin committed Jan 25, 2020
1 parent 952e2ad commit 22c320e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://semver.org/>`_.

If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section.

See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.

Contributing to this repo
Expand All @@ -40,6 +42,11 @@ Contributing to this repo

Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ 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
----------------

Expand Down

0 comments on commit 22c320e

Please sign in to comment.