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

     1  <h2>Nut specification</h2>
     2  
     3  Nut metadata is stored in two places. Standard Go entities like package name and import path are accessible via standard package <a href="http://golang.org/pkg/go/build/"><code>go/build</code></a>. The rest is stored in file called <code>nut.json</code>, which can be created and updated with <code>nut generate</code> command. This document defines its format.
     4  
     5  <pre>
     6  {
     7    "Version": "0.3.0",
     8    "Vendor": "aleksi",
     9    "Authors": [
    10      {
    11        "FullName": "Alexey Palazhchenko",
    12        "Email": "alexey.palazhchenko@gmail.com"
    13      }
    14    ],
    15    "ExtraFiles": [
    16      "CHANGELOG",
    17      "CONTRIBUTING.md",
    18      "LICENSE",
    19      "README.md"
    20    ],
    21    "Homepage": "http://gonuts.io/"
    22  }
    23  </pre>
    24  
    25  <ul>
    26  	<li>Version defines nut version according to <a href="/-/doc/versioning">specification</a>.</li>
    27  	<li>Vendor is a user or project name. Together with package name it forms a nut URL: <code>gonuts.io/aleksi/nut</code></li>
    28  	<li>Author defines nut authors and maintainers. Each array element contains full name and optional e-mail.</li>
    29  	<li>ExtraFiles defines an array of files which are a part of nut, but do not contain code and therefore are not a part of Go package.</li>
    30  	<li>Homepage defines nut's homepage in a form of HTTP/HTTPS URL.</li>
    31  </ul>