X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=doc%2Fbuilding.texi;h=03eda87e2e85d88bc52bc87cecd7bb88c9d5282e;hb=7f71f37675f61b4081ad6fef2a936f1c7eb620f9;hp=2a2bfc1db4448cdf0b42bfc6ecce898c2a074451;hpb=9d80ad45bc2a002c256766886c1d43e61799536f;p=nncp.git diff --git a/doc/building.texi b/doc/building.texi index 2a2bfc1..03eda87 100644 --- a/doc/building.texi +++ b/doc/building.texi @@ -19,15 +19,37 @@ $ 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 either dozen of various implementations, or at -least minimalistic POSIX shell @command{contrib/do} (just replace +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. +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} make-target respecting @env{DESTDIR}. It will +There is @command{install} target respecting @env{$DESTDIR}. It will install binaries and info-documentation: @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: + +@example +$ GO_CFLAGS="-tags nofsnotify" redo ... +@end example + +You can also disable Yggdrasil support with @code{-tags noyggdrasil}.