Fix workability under GNU/Linux and other systems because of different syscall

[goredo.git] / README

diff --git a/README b/README
index d49c3cc020e7ef506840eb72492e68cd031f617e..a35eab3de85e5246da7c737de1718af811ba3109 100644 (file)
--- a/README
+++ b/README
@@ -9,25 +9,30 @@ apenwarr/redo (https://redo.readthedocs.io/en/latest/) were also
 implemented. Why yet another implementation? It is feature full and has
 better performance comparing to shell and Python implementation.
 
+It passes tests from dieweltistgarnichtso.net's redo-sh.tests and
+implementation-neutral from apenwarr/redo.
+
 goredo is free software: see the file COPYING for copying conditions.
 Home page: http://www.goredo.cypherpunks.ru/
 
 INSTALL                                                 *goredo-install*
+
+Hopefully it should work on all POSIX systems.
  >
     $ go get go.cypherpunks.ru/goredo
     $ goredo -symlinks
     $ export PATH=`pwd`:$PATH
 
-If you have problems with *.golang.org's unability to verify
+If you have problems with *.golang.org's inability 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.5.0
+    $ git tag -v v0.8.0
     $ git clone git://git.cypherpunks.ru/gorecfile.git
-    $ ( cd gorecfile ; git tag -v v0.3.0 )
+    $ ( cd gorecfile ; git tag -v v0.4.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.2.0 )
@@ -41,12 +46,15 @@ NOTES                                                     *goredo-notes*
 * "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 $3 is relative path to the file in same directory
+* .do's $3 is relative path to the file in target 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
 * 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
+* tracing (-x) can be obviously done only for non-executable .do
+* parallizable build is done only during redo-ifchange for human
+  convenience: you can globally enable REDO_JOBS, but still do for
+  example: redo htmls infos index upload
 
 FEATURES                                               *goredo-features*
 
@@ -96,6 +104,7 @@ COMMANDS                                               *goredo-commands*
     default.do
     ../default.b.o.do
     ../default.o.do
+    ../default.do
 * redo-dot -- dependency DOT graph generator. For example to visualize
   your dependencies with GraphViz: >
     $ redo target [...] # to assure that **/.redo/*.dep are filled up
@@ -163,8 +172,8 @@ is rather heavy. Of course, because of either hashing or possible
 redo-stamp-ing its dependants won't be rebuilt further, but build time
 will be already ruined. If you need to rebuild TeX documents (case
 mentioned in redo-sh's FAQ) until all references and numbers are ready,
-then you must simply explicitly use while cycle in your .do, as
-apenwarr/redo already suggests.
+then you must naturally expectedly explicitly use while cycle in your
+.do, as apenwarr/redo already suggests.
 
 STATE                                                     *goredo-state*