From 357e4f67134aaae7995ebac32e0272e781bc94e1 Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Fri, 13 Jan 2017 12:44:58 +0300 Subject: [PATCH] Platform-specific installation instructions --- doc/download.texi | 14 +++++++++++ doc/install.texi | 32 ++++------------------- doc/platforms.texi | 63 ++++++++++++++++++++++++++++++++++++++++++++++ doc/sources.texi | 4 +-- 4 files changed, 84 insertions(+), 29 deletions(-) create mode 100644 doc/platforms.texi diff --git a/doc/download.texi b/doc/download.texi index 8d300e2..0ff94fa 100644 --- a/doc/download.texi +++ b/doc/download.texi @@ -5,6 +5,20 @@ You can obtain releases source code prepared tarballs from the links below (or use @url{https://sourceforge.net/projects/nncp/files/, Sourceforge mirror}). Do not forget to check tarball @ref{Integrity, integrity}. +Tarballs include all necessary required libraries: + +@multitable @columnfractions .50 .50 +@headitem Library @tab Licence +@item @code{github.com/dustin/go-humanize} @tab MIT +@item @code{github.com/flynn/noise} @tab BSD 3-Clause +@item @code{github.com/go-check/check} @tab BSD 2-Clause +@item @code{github.com/go-yaml/yaml} @tab Apache License 2.0 and MIT +@item @code{github.com/minio/blake2b-simd} @tab Apache License 2.0 +@item @code{golang.org/x/crypto} @tab BSD 3-Clause +@item @code{golang.org/x/net} @tab BSD 3-Clause +@item @code{golang.org/x/sys} @tab BSD 3-Clause +@end multitable + @multitable {XXXXX} {XXXX KiB} {link sign} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} @headitem Version @tab Size @tab Tarball @tab SHA256 checksum diff --git a/doc/install.texi b/doc/install.texi index a362193..9dec382 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -10,41 +10,19 @@ recommended). @emph{Make} (BSD and GNU ones are fine) is recommended for convenient building. @url{https://www.gnu.org/software/texinfo/, Texinfo} is used for building documentation. -Included required libraries: - -@multitable @columnfractions .50 .50 -@headitem Library @tab Licence -@item @code{github.com/dustin/go-humanize} @tab MIT -@item @code{github.com/flynn/noise} @tab BSD 3-Clause -@item @code{github.com/go-check/check} @tab BSD 2-Clause -@item @code{github.com/go-yaml/yaml} @tab Apache License 2.0 and MIT -@item @code{github.com/minio/blake2b-simd} @tab Apache License 2.0 -@item @code{golang.org/x/crypto} @tab BSD 3-Clause -@item @code{golang.org/x/net} @tab BSD 3-Clause -@item @code{golang.org/x/sys} @tab BSD 3-Clause -@end multitable - -Get @ref{Tarballs, the tarball}, check its +In general you must get @ref{Tarballs, the tarball}, check its @ref{Integrity, integrity and authenticity} and run @command{make}. -@emph{nncp-*} binaries will be built in the current directory: - -@verbatim -% wget http://www.nncpgo.org/download/nncp-0.1.tar.xz -% wget http://www.nncpgo.org/download/nncp-0.1.tar.xz.sig -% gpg --verify nncp-0.1.tar.xz.sig nncp-0.1.tar.xz -% tar xf nncp-0.1.tar.xz -% make -C nncp-0.1 all -@end verbatim - -There is @code{install} target respecting @env{DESTDIR}. It will -install binaries and info-documentation. +Look for general and @ref{Platform-specific, platform-specific} +installation instructions. @menu * Prepared tarballs: Tarballs. * Tarballs integrity check: Integrity. +* Platform-specific instructions: Platform-specific. * Development source code: Sources. @end menu @include download.texi @include integrity.texi +@include platforms.texi @include sources.texi diff --git a/doc/platforms.texi b/doc/platforms.texi new file mode 100644 index 0000000..56a7412 --- /dev/null +++ b/doc/platforms.texi @@ -0,0 +1,63 @@ +@node Platform-specific +@section Platform-specific instructions + +@node General +@subsection General installation instructions + +@verbatim +% wget http://www.nncpgo.org/download/nncp-0.1.tar.xz +% wget http://www.nncpgo.org/download/nncp-0.1.tar.xz.sig +% gpg --verify nncp-0.1.tar.xz.sig nncp-0.1.tar.xz +% tar xf nncp-0.1.tar.xz +% make -C nncp-0.1 all +@end verbatim + +There is @code{install} target respecting @env{DESTDIR}. It will +install binaries and info-documentation. + +@node FreeBSD +@subsection FreeBSD installation instructions + +Look @ref{Integrity, here} for finding public keys for tarball authentication. + +@verbatim +# pkg install go +@end verbatim + +follow @ref{General, general} installation instructions + +@verbatim +# make -C nncp-0.1 install +@end verbatim + +@node Ubuntu +@subsection Ubuntu installation instructions + +Look @ref{Integrity, here} for finding public keys for tarball authentication. + +@table @asis +@item Ubuntu 16.04 + +@verbatim +# apt install golang +@end verbatim + +follow @ref{General, general} installation instructions + +@verbatim +# make -C nncp-0.1 install PREFIX=/usr +@end verbatim + +@item Ubuntu 14.04 + +@verbatim +# apt-get install golang-1.6 +% wget http://www.nncpgo.org/download/nncp-0.1.tar.xz +% wget http://www.nncpgo.org/download/nncp-0.1.tar.xz.sig +% gpg --verify nncp-0.1.tar.xz.sig nncp-0.1.tar.xz +% tar xf nncp-0.1.tar.xz +% PATH=/usr/lib/go-1.6/bin:$PATH make -C nncp-0.1 all +# make -C nncp-0.1 install PREFIX=/usr +@end verbatim + +@end table diff --git a/doc/sources.texi b/doc/sources.texi index d1d1bd9..a259df0 100644 --- a/doc/sources.texi +++ b/doc/sources.texi @@ -3,8 +3,8 @@ Development source code contains the latest version of the code. It may be buggy. It does not contain compiled documentation and dependent -libraries source code. Because of that, it is not recommended for -porters to use @ref{Tarballs} instead. +libraries source code. Because of that, it is recommended for porters +to use @ref{Tarballs, tarballs} instead. You can obtain it by cloning @url{http://git-scm.com/, Git} @url{http://git.cypherpunks.ru/cgit.cgi/nncp.git/log/, repository} -- 2.44.0