github.com/aleksi/gonuts.io@v0.0.0-20130622121132-3b0f2d1999fb/app/gonuts/templates/base/doc_howto.html (about)

     1  <h2>How to…</h2>
     2  
     3  <h3>Install nut tool</h3>
     4  
     5  Make sure your <a href="http://golang.org/doc/code.html#tmp_2">GOPATH</a> is correct (check output of <code>go env</code>). Then type
     6  <pre>
     7  go get -u github.com/AlekSi/nut/...
     8  </pre>
     9  It will install nut binary into <code>$GOPATH/bin</code>. Then it's a nice idea to create empty config file <code>~/.nut.json</code> – it will be updated by nut tool.
    10  <pre>
    11  touch ~/.nut.json
    12  </pre>
    13  
    14  Check installation with
    15  <pre>
    16  nut help
    17  </pre>
    18  
    19  <h3>Install a nut</h3>
    20  
    21  <pre>
    22  nut get gonuts.io/vendor/nut
    23  </pre>
    24  to install latest version, or
    25  <pre>
    26  nut get gonuts.io/vendor/nut/version
    27  </pre>
    28  to install specific version. In both cases <code>gonuts.io/</code> is optional. Package will be installed into <code>$GOPATH/src/gonuts.io/vendor/nut</code>, import path is <code>gonuts.io/vendor/nut</code>.
    29  
    30  <h3>Publish a nut</h3>
    31  
    32  To publish a package as nut on gonuts.io you should:
    33  <ul>
    34  	<li><a href="/-/me">register</a> on this site, choose a vendor name and copy access token to <code>~/.nut.json</code>;</li>
    35  	<li>run <code>nut generate</code> inside package directory to generate <a href="/-/doc/spec"><code>spec.json</code></a>, edit it;</li>
    36  	<li>run <code>nut pack</code>;</li>
    37  	<li>run <code>nut publish [filename]</code>.</li>
    38  </ul>