]> Cypherpunks.ru repositories - goredo.git/blobdiff - README
Up to date installation instruction
[goredo.git] / README
diff --git a/README b/README
index d7149f114e0ee7780f585446a98cc6b7c399e99d..bfd862ecafecfb99dbf289733654517354eae20d 100644 (file)
--- a/README
+++ b/README
@@ -13,26 +13,37 @@ goredo is free software: see the file COPYING for copying conditions.
 Home page: http://www.goredo.cypherpunks.ru/
 
 INSTALL                                                 *goredo-install*
-
-Either: >
+ >
     $ go get go.cypherpunks.ru/goredo
     $ goredo -symlinks
     $ export PATH=`pwd`:$PATH
-or: >
+
+If you have problems with *.golang.org's unability to verify
+authenticity of go.cypherpunks.ru TLS connection, then you can disable
+their usage by setting GOPRIVATE=go.cypherpunks.ru. If you still have
+problems with the authenticity on your side, then build it manually: >
+
     $ git clone git://git.cypherpunks.ru/goredo.git
     $ cd goredo
+    $ git tag -v v0.4.0
+    $ git clone git://git.cypherpunks.ru/gorecfile.git
+    $ ( cd gorecfile ; git tag -v v0.3.0 )
+    $ echo "replace go.cypherpunks.ru/recfile => `pwd`/gorecfile" >> go.mod
+    $ git clone git://git.cypherpunks.ru/gotai64n.git
+    $ ( cd gotai64n ; git tag -v v0.1.0 )
+    $ echo "replace go.cypherpunks.ru/tai64n => `pwd`/gotai64n" >> go.mod
     $ go build
     $ ./goredo -symlinks
     $ export PATH=`pwd`:$PATH
-<
+
 NOTES                                                     *goredo-notes*
 
-* "all" target is used by default
+* "all" target is default
 * stdout is always captured, but no target is created if it was empty
 * empty targets are considered always out of date
-* .do's arguments are relative paths
+* .do's $3 is relative path to the file in same directory
 * .do search goes up to / by default, but can be limited with either
-  REDO_TOP_DIR environment variable, or by having .redo/top file in it
+  $REDO_TOP_DIR environment variable, or by having .redo/top file in it
 * target's completion messages are written after they finish
 * executable .do is run as is, non-executable is run with /bin/sh -e[x]
 * tracing (-x) can be done only for non-executable .do
@@ -53,21 +64,21 @@ FEATURES                                               *goredo-features*
 * verbose debug messages, including out-of-date determination, PIDs,
   lock and jobserver acquirings/releases
 * displaying of each target's execution time
-* each target's stderr can be displayed with the PID
+* each target's stderr can be prefixed with the PID
 * optional statusline with currently running/waiting/done jobs
 * target's stderr can be stored on the disk with TAI64N timestamp
   prefixes for each line. To convert them to localtime you can use either
   tai64nlocal utility from daemontools (http://cr.yp.to/daemontools.html)
   or make a symlink, to use built-in slower decoder: >
     $ ln -s goredo tai64nlocal
-<
+
 COMMANDS                                               *goredo-commands*
 
-* redo-ifchange, redo-ifcreate, redo-always (useful with redo-stamp)
-* redo -- same as redo-ifchange, but forcefully and *sequentially* run
+* redo-ifchange, redo-ifcreate, redo-always
+* redo -- same as redo-ifchange, but forcefully and sequentially run
   specified targets
 * redo-log -- display TAI64N timestamped last stderr of the target
-* redo-stamp -- record stamp dependency. Nothing more, just dummy
+* redo-stamp -- record stamp dependency. Nothing more, dummy
 * redo-cleanup -- removes either temporary, log files, or everything
   related to goredo
 * redo-whichdo -- .do search paths for specified target (similar to
@@ -87,33 +98,33 @@ COMMANDS                                               *goredo-commands*
     ../default.o.do
 * redo-dot -- dependency DOT graph generator. For example to visualize
   your dependencies with GraphViz: >
-    $ redo target [...] # to assure that .redo is filled up
+    $ redo target [...] # to assure that **/.redo/*.dep are filled up
     $ redo-dot target [...] > whatever.dot
     $ dot -Tpng whatever.dot > whatever.png # possibly add -Gsplines=ortho
-<
+
 FAQ                                                         *goredo-faq*
 
     Hashing and stamping~
 
 All targets are checksummed if their ctime differs from the previous
-ones. apenwarr/redo gives many reasons why every time checksumming is
-bad, but in my opinion in practice all of his reasons do not apply.
+one. apenwarr/redo gives many reasons why every time checksumming is
+bad, but in my opinion in practice all of them do not apply.
 
 * Aggregate targets and willing to be out-of-date ones just must not
   produce empty output files. apenwarr/*, redo-c and goredo
   implementations consider non existing file as an out-of-date target
-* If you really wish to produce an empty target file, just: touch $3
+* If you really wish to produce an empty target file, just touch $3
 
 DJB's proposal with both stdout and $3 gives that ability to control
 your desired behaviour. Those who does not capture stdout -- failed.
 Those who creates an empty file if no stdout was written -- failed.
 
-redo is a tool for helping people. Literally all targets can be safely
+redo is a tool to help people. Literally all targets can be safely
 "redo-stamp < $3"-ed, reducing false positive out-of-dates. Of course,
-with the correct working with stdout/$3 and placing necessary results in
-$3, instead of just silently feeding them in redo-stamp.
+with the correct stdout/$3 working and placing necessary results in $3,
+instead of just silently feeding them in redo-stamp.
 
-redo implementations are already automatically records -ifchange on .do
+redo implementations are already automatically record -ifchange on .do
 files and -ifcreate on non-existing .do files. So why they can not
 record redo-stamp the same way implicitly? No, Zen of Python does not
 applicable there, because -ifchange/-ifcreate contradict it already.
@@ -139,8 +150,8 @@ just remove foo/.redo/bar.dep.
 STATE                                                     *goredo-state*
 
 Dependency and build state is kept inside .redo subdirectory in each
-directory touched related the build. Each corresponding target has its
-own, recreated with every rebuild, .dep file. It is recfile
+directory related the build. Each corresponding target has its own,
+recreated with every rebuild, .dep file. It is recfile
 (https://www.gnu.org/software/recutils/), that could have various
 dependency information (dep.rec with the schema included): >
 
@@ -158,7 +169,11 @@ dependency information (dep.rec with the schema included): >
 
     Type: stamp
     Hash: 5bbdf635932cb16b9127e69b6f3872577efed338f0a4ab6f2c7ca3df6ce50cc9
-<
+
+USAGE                                                     *goredo-usage*
+
+Run any of the command above with the -help.
+
 LICENCE~
 
 This program is free software: you can redistribute it and/or modify