X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=doc%2Fbuilding.texi;h=fee272e1bde547d554f2148452cd544f1e80f0c9;hb=c12d6ee76fc66031756602976831f97624fc28f2;hp=4f30e3e7dfee2f652cb8009de2fd1a6377517f38;hpb=11516a2bbce2b39bda71cf716eaeaf1ffb62314a;p=nncp.git diff --git a/doc/building.texi b/doc/building.texi index 4f30e3e..fee272e 100644 --- a/doc/building.texi +++ b/doc/building.texi @@ -10,17 +10,40 @@ Make sure that Go is installed. For example to install it from packages: @verb{|apt install golang|} @end table -@verbatim -$ [fetch|wget] http://www.nncpgo.org/download/nncp-5.1.2.tar.xz -$ [fetch|wget] http://www.nncpgo.org/download/nncp-5.1.2.tar.xz.sig -$ gpg --verify nncp-5.1.2.tar.xz.sig nncp-5.1.2.tar.xz -$ xz --decompress --stdout nncp-5.1.2.tar.xz | tar xf - -$ make -C nncp-5.1.2 all -@end verbatim - -There is @command{install} make-target respecting @env{DESTDIR}. It will +@example +$ [fetch|wget] http://www.nncpgo.org/download/nncp-@value{VERSION}.tar.xz +$ [fetch|wget] http://www.nncpgo.org/download/nncp-@value{VERSION}.tar.xz.sig +$ gpg --verify nncp-@value{VERSION}.tar.xz.sig nncp-@value{VERSION}.tar.xz +$ xz --decompress --stdout nncp-@value{VERSION}.tar.xz | tar xf - +$ cd nncp-@value{VERSION} +$ redo all +@end example + +After that you should get various @command{bin/nncp-*} binaries and +@command{bin/hjson-cli} command (only for your convenience, not +necessary installation). For example, documentation for +@command{nncp-bundle} command can be get with +@command{info doc/nncp.info -n nncp-bundle}. + +It uses @url{http://cr.yp.to/redo.html, redo} build system for that +examples. You can use one of its various implementations, or at least +minimalistic POSIX shell @command{contrib/do} (just replace +@command{redo} with @command{contrib/do} in the example above) included +in tarball. Following ones are tested to work with: +@url{http://www.goredo.cypherpunks.ru/, goredo} (NNCP's author creation), +@url{https://redo.readthedocs.io/, apenwarr/redo} (@code{contrib/do} is +from that project), @url{https://github.com/leahneukirchen/redo-c, redo-c}, +@url{https://github.com/gotroyb127/baredo, baredo}. + +There is @command{install} target respecting @env{$DESTDIR}. It will install binaries and info-documentation: -@verbatim -# make -C nncp-5.1.2 install PREFIX=/usr/local -@end verbatim +@example +# PREFIX=/usr/local redo install +@end example + +NNCP depends on @code{github.com/fsnotify/fsnotify} library, that is +solely relies on OS-specific mechanisms. There is possibility that you +have either broken or unsupported ones. You can still build NNCP with +@code{-tags nofsnotify} build option, to skip @code{fsnotify} library +usage at all.