doc/install.texi

   1 @node Installation
   2 @unnumbered Installation
   3
   4 NNCP should run on any POSIX-compatible operating system with file
   5 systems supporting directory and filename's length up to 57 characters.
   6
   7 NNCP is written on @url{https://golang.org/, Go} programming language
   8 and you have to install Go compiler (1.7+ version is highly
   9 recommended). @emph{Make} (BSD and GNU ones are fine) is recommended for
  10 convenient building. @url{https://www.gnu.org/software/texinfo/,
  11 Texinfo} is used for building documentation.
  12
  13 Included required libraries:
  14
  15 @multitable @columnfractions .50 .50
  16 @headitem Library @tab Licence
  17 @item @code{github.com/dustin/go-humanize} @tab MIT
  18 @item @code{github.com/flynn/noise} @tab BSD 3-Clause
  19 @item @code{github.com/go-check/check} @tab BSD 2-Clause
  20 @item @code{github.com/go-yaml/yaml} @tab Apache License 2.0 and MIT
  21 @item @code{github.com/minio/blake2b-simd} @tab Apache License 2.0
  22 @item @code{golang.org/x/crypto} @tab BSD 3-Clause
  23 @item @code{golang.org/x/net} @tab BSD 3-Clause
  24 @item @code{golang.org/x/sys} @tab BSD 3-Clause
  25 @end multitable
  26
  27 Get @ref{Tarballs, the tarball}, check its
  28 @ref{Integrity, integrity and authenticity} and run @command{make}.
  29 @emph{nncp-*} binaries will be built in the current directory:
  30
  31 @verbatim
  32 % wget http://www.nncpgo.org/download/nncp-0.1.tar.xz
  33 % wget http://www.nncpgo.org/download/nncp-0.1.tar.xz.sig
  34 % gpg --verify nncp-0.1.tar.xz.sig nncp-0.1.tar.xz
  35 % tar xf nncp-0.1.tar.xz
  36 % make -C nncp-0.1 all
  37 @end verbatim
  38
  39 There is @code{install} target respecting @env{DESTDIR}. It will
  40 install binaries and info-documentation.
  41
  42 @menu
  43 * Prepared tarballs: Tarballs.
  44 * Tarballs integrity check: Integrity.
  45 * Development source code: Sources.
  46 @end menu
  47
  48 @include download.texi
  49 @include integrity.texi
  50 @include sources.texi